Smaws_Client_SFN.Typestype nonrec variable_name_list = variable_name listtype nonrec variable_references = (state_name * variable_name_list) listtype nonrec validation_exception = {reason : validation_exception_reason option;The input does not satisfy the constraints specified by an Amazon Web Services service.
*)message : error_message option;}The input does not satisfy the constraints specified by an Amazon Web Services service.
type nonrec validate_state_machine_definition_diagnostic = {location : validate_state_machine_definition_location option;Location of the issue in the state machine, if available.
For errors specific to a field, the location could be in the format:
/States//, for example: /States/FailState/ErrorPath.
message : validate_state_machine_definition_message;Message describing the diagnostic condition.
*)code : validate_state_machine_definition_code;Identifying code for the diagnostic.
*)severity : validate_state_machine_definition_severity;A value of ERROR means that you cannot create or update a state machine with this definition.
WARNING level diagnostics alert you to potential issues, but they will not prevent you from creating or updating your state machine.
}Describes potential issues found during state machine validation. Rather than raise an exception, validation will return a list of diagnostic elements containing diagnostic information.
The ValidateStateMachineDefinitionlAPI might add new diagnostics in the future, adjust diagnostic codes, or change the message wording. Your automated processes should only rely on the value of the result field value (OK, FAIL). Do not rely on the exact order, count, or wording of diagnostic messages.
List of warning codes
NO_DOLLAR No .$ on a field that appears to be a JSONPath or Intrinsic Function.
NO_PATH Field value looks like a path, but field name does not end with 'Path'.
PASS_RESULT_IS_STATIC Attempt to use a path in the result of a pass state.
List of error codes
INVALID_JSON_DESCRIPTION JSON syntax problem found.
MISSING_DESCRIPTION Received a null or empty workflow input.
SCHEMA_VALIDATION_FAILED Schema validation reported errors.
INVALID_RESOURCE The value of a Task-state resource field is invalid.
MISSING_END_STATE The workflow does not have a terminal state.
DUPLICATE_STATE_NAME The same state name appears more than once.
INVALID_STATE_NAME The state name does not follow the naming convention.
STATE_MACHINE_NAME_EMPTY The state machine name has not been specified.
STATE_MACHINE_NAME_INVALID The state machine name does not follow the naming convention.
STATE_MACHINE_NAME_TOO_LONG The state name exceeds the allowed length.
STATE_MACHINE_NAME_ALREADY_EXISTS The state name already exists.
DUPLICATE_LABEL_NAME A label name appears more than once.
INVALID_LABEL_NAME You have provided an invalid label name.
MISSING_TRANSITION_TARGET The value of "Next" field doesn't match a known state name.
TOO_DEEPLY_NESTED The states are too deeply nested.
type nonrec validate_state_machine_definition_diagnostic_list =
validate_state_machine_definition_diagnostic listtype nonrec validate_state_machine_definition_output = {truncated : validate_state_machine_definition_truncated option;The result value will be true if the number of diagnostics found in the workflow definition exceeds maxResults. When all diagnostics results are returned, the value will be false.
diagnostics : validate_state_machine_definition_diagnostic_list;An array of diagnostic errors and warnings found during validation of the state machine definition. Since warnings do not prevent deploying your workflow definition, the result value could be OK even when warning diagnostics are present in the response.
result : validate_state_machine_definition_result_code;The result value will be OK when no syntax errors are found, or FAIL if the workflow definition does not pass verification.
}type nonrec validate_state_machine_definition_input = {max_results : validate_state_machine_definition_max_result option;The maximum number of diagnostics that are returned per call. The default and maximum value is 100. Setting the value to 0 will also use the default of 100.
If the number of diagnostics returned in the response exceeds maxResults, the value of the truncated field in the response will be set to true.
severity : validate_state_machine_definition_severity option;Minimum level of diagnostics to return. ERROR returns only ERROR diagnostics, whereas WARNING returns both WARNING and ERROR diagnostics. The default is ERROR.
type_ : state_machine_type option;The target type of state machine for this definition. The default is STANDARD.
definition : definition;The Amazon States Language definition of the state machine. For more information, see Amazon States Language (ASL).
*)}type nonrec update_state_machine_output = {state_machine_version_arn : arn option;The Amazon Resource Name (ARN) of the published state machine version.
If the publish parameter isn't set to true, this field returns null.
revision_id : revision_id option;The revision identifier for the updated state machine.
*)update_date : timestamp;The date and time the state machine was updated.
*)}type nonrec cloud_watch_logs_log_group = {log_group_arn : arn option;The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
}type nonrec log_destination = {cloud_watch_logs_log_group : cloud_watch_logs_log_group option;An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the CloudFormation User Guide.
*)}type nonrec log_destination_list = log_destination listtype nonrec logging_configuration = {destinations : log_destination_list option;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.
include_execution_data : include_execution_data option;Determines whether execution data is included in your log. When set to false, data is excluded.
level : log_level option;Defines which category of execution history events are logged.
*)}The LoggingConfiguration data type is used to set CloudWatch Logs options.
type nonrec tracing_configuration = {enabled : enabled option;When set to true, X-Ray tracing is enabled.
}Selects whether or not the state machine's X-Ray tracing is enabled. Default is false
type nonrec encryption_configuration = {type_ : encryption_type;Encryption type
*)kms_data_key_reuse_period_seconds : kms_data_key_reuse_period_seconds option;Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey. Only applies to customer managed keys.
kms_key_id : kms_key_id option;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.
*)}Settings to configure server-side encryption.
For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines and activities. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine, and when creating an Activity. The execution history and state machine definition will be encrypted with the key applied to the State Machine. Activity inputs will be encrypted with the key applied to the Activity.
Step Functions automatically enables encryption at rest using Amazon Web Services owned keys at no charge. However, KMS charges apply when using a customer managed key. For more information about pricing, see Key Management Service pricing.
For more information on KMS, see What is Key Management Service?
type nonrec update_state_machine_input = {encryption_configuration : encryption_configuration option;Settings to configure server-side encryption.
*)version_description : version_description option;An optional description of the state machine version to publish.
You can only specify the versionDescription parameter if you've set publish to true.
publish : publish option;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.
tracing_configuration : tracing_configuration option;Selects whether X-Ray tracing is enabled.
*)logging_configuration : logging_configuration option;Use the LoggingConfiguration data type to set CloudWatch Logs options.
role_arn : arn option;The Amazon Resource Name (ARN) of the IAM role of the state machine.
*)definition : definition option;state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine.
*)}type nonrec update_state_machine_alias_output = {update_date : timestamp;The date and time the state machine alias was updated.
*)}type nonrec routing_configuration_list_item = {weight : version_weight;The percentage of traffic you want to route to a state machine version. The sum of the weights in the routing configuration must be equal to 100.
*)state_machine_version_arn : arn;The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
If you specify the ARN of a second version, it must belong to the same state machine as the first version.
*)}Contains details about the routing configuration of a state machine alias. In a routing configuration, you define an array of objects that specify up to two state machine versions. You also specify the percentage of traffic to be routed to each version.
type nonrec routing_configuration_list = routing_configuration_list_item listtype nonrec update_state_machine_alias_input = {routing_configuration : routing_configuration_list option;The routing configuration of the state machine alias.
An array of RoutingConfig objects that specifies up to two state machine versions that the alias starts executions for.
description : alias_description option;A description of the state machine alias.
*)state_machine_alias_arn : arn;The Amazon Resource Name (ARN) of the state machine alias.
*)}The specified state machine is being deleted.
Could not find the referenced resource.
The provided Amazon Resource Name (ARN) is not valid.
Updating or deleting a resource can cause an inconsistent state. This error occurs when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion, or UpdateStateMachine with the publish parameter set to true.
HTTP Status Code: 409
The specified state machine does not exist.
The request would cause a service quota to be exceeded.
HTTP Status Code: 402
Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.
Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
Either your KMS key policy or API caller does not have the required permissions.
Your tracingConfiguration key does not match, or enabled has not been set to true or false.
Configuration is not valid.
Received when encryptionConfiguration is specified but various conditions exist which make the configuration invalid. For example, if type is set to CUSTOMER_MANAGED_KMS_KEY, but kmsKeyId is null, or kmsDataKeyReusePeriodSeconds is not between 60 and 900, or the KMS key is not symmetric or inactive.
The provided Amazon States Language definition is not valid.
type nonrec update_map_run_input = {tolerated_failure_count : tolerated_failure_count option;The maximum number of failed items before the Map Run fails.
*)tolerated_failure_percentage : tolerated_failure_percentage option;The maximum percentage of failed items before the Map Run fails.
*)max_concurrency : max_concurrency option;The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.
*)map_run_arn : long_arn;The Amazon Resource Name (ARN) of a Map Run.
*)}type nonrec tag_key_list = tag_key listtype nonrec untag_resource_input = {tag_keys : tag_key_list;The list of tags to remove from the resource.
*)resource_arn : arn;The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
*)}You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.
type nonrec inspection_data_request = {body : http_body option;The request body for the HTTP request.
*)headers : http_headers option;The request headers associated with the HTTP request.
*)url : ur_l option;The API endpoint used for the HTTP request.
*)method_ : http_method option;The HTTP method used for the HTTP request.
*)protocol : http_protocol option;The protocol used to make the HTTP request.
*)}Contains additional details about the state's execution, including its input and output data processing flow, and HTTP request information.
type nonrec inspection_data_response = {body : http_body option;The HTTP response returned.
*)headers : http_headers option;The response headers associated with the HTTP response.
*)status_message : http_status_message option;The message associated with the HTTP status code.
*)status_code : http_status_code option;The HTTP response status code for the HTTP response.
*)protocol : http_protocol option;The protocol used to return the HTTP response.
*)}Contains additional details about the state's execution, including its input and output data processing flow, and HTTP response information. The inspectionLevel request parameter specifies which details are returned.
type nonrec inspection_data = {variables : sensitive_data option;JSON string that contains the set of workflow variables after execution of the state. The set will include variables assigned in the state and variables set up as test state input.
*)response : inspection_data_response option;The raw HTTP response that is returned when you test an HTTP Task.
*)request : inspection_data_request option;The raw HTTP request that is sent when you test an HTTP Task.
*)after_result_path : sensitive_data option;The effective result combined with the raw state input after Step Functions applies the ResultPath filter. Not populated when QueryLanguage is JSONata.
*)after_result_selector : sensitive_data option;The effective result after Step Functions applies the ResultSelector filter. Not populated when QueryLanguage is JSONata.
*)result : sensitive_data option;The state's raw result.
*)after_parameters : sensitive_data option;The effective input after Step Functions applies the Parameters filter. Not populated when QueryLanguage is JSONata.
*)after_input_path : sensitive_data option;The input after Step Functions applies the InputPath filter. Not populated when QueryLanguage is JSONata.
*)after_arguments : sensitive_data option;The input after Step Functions applies an Arguments filter. This event will only be present when QueryLanguage for the state machine or individual states is set to JSONata. For more info, see Transforming data with Step Functions.
*)input : sensitive_data option;The raw state input.
*)}Contains additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information.
type nonrec test_state_output = {status : test_execution_status option;The execution status of the state.
*)next_state : state_name option;The name of the next state to transition to. If you haven't defined a next state in your definition or if the execution of the state fails, this field doesn't contain a value.
*)inspection_data : inspection_data option;Returns additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information. The inspectionLevel request parameter specifies which details are returned.
cause : sensitive_cause option;A detailed explanation of the cause for the error when the execution of a state fails.
*)error : sensitive_error option;The error returned when the execution of a state fails.
*)output : sensitive_data option;The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)}type nonrec test_state_input = {variables : sensitive_data option;JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.
*)reveal_secrets : reveal_secrets option;Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.
If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.
By default, revealSecrets is set to false.
inspection_level : inspection_level option;Determines the values to return when a state is tested. You can specify one of the following types:
INFO: Shows the final state output. By default, Step Functions sets inspectionLevel to INFO if you don't specify a level.DEBUG: Shows the final state output along with the input and output data processing result.TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.Each of these levels also provide information about the status of the state execution and the next state to transition to.
*)input : sensitive_data option;A string that contains the JSON input data for the state.
*)role_arn : arn option;The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
*)definition : definition;}The provided JSON input data is not valid.
type nonrec task_timed_out_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)resource : name;The action of the resource called by a task state.
*)resource_type : name;The service name of the resource in a task state.
*)}Contains details about a resource timeout that occurred during an execution.
The task token has either expired or the task associated with the token has already been closed.
type nonrec history_event_execution_data_details = {truncated : truncated option;Indicates whether input or output was truncated in the response. Always false for API calls. In CloudWatch logs, the value will be true if the data is truncated due to size limits.
}Provides details about input or output in an execution history event.
type nonrec task_succeeded_event_details = {output_details : history_event_execution_data_details option;Contains details about the output of an execution history event.
*)output : sensitive_data option;The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)resource : name;The action of the resource called by a task state.
*)resource_type : name;The service name of the resource in a task state.
*)}Contains details about the successful completion of a task state.
type nonrec task_submitted_event_details = {output_details : history_event_execution_data_details option;Contains details about the output of an execution history event.
*)output : sensitive_data option;The response from a resource when a task has started. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)resource : name;The action of the resource called by a task state.
*)resource_type : name;The service name of the resource in a task state.
*)}Contains details about a task submitted to a resource .
type nonrec task_submit_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)resource : name;The action of the resource called by a task state.
*)resource_type : name;The service name of the resource in a task state.
*)}Contains details about a task that failed to submit during an execution.
type nonrec task_started_event_details = {resource : name;The action of the resource called by a task state.
*)resource_type : name;The service name of the resource in a task state.
*)}Contains details about the start of a task during an execution.
type nonrec task_start_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)resource : name;The action of the resource called by a task state.
*)resource_type : name;The service name of the resource in a task state.
*)}Contains details about a task that failed to start during an execution.
type nonrec task_credentials = {role_arn : long_arn option;The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.
*)}Contains details about the credentials that Step Functions uses for a task.
type nonrec task_scheduled_event_details = {task_credentials : task_credentials option;The credentials that Step Functions uses for the task.
*)heartbeat_in_seconds : timeout_in_seconds option;The maximum allowed duration between two heartbeats for the task.
*)timeout_in_seconds : timeout_in_seconds option;The maximum allowed duration of the task.
*)parameters : connector_parameters;The JSON data passed to the resource referenced in a task state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)region : name;The region of the scheduled task
*)resource : name;The action of the resource called by a task state.
*)resource_type : name;The service name of the resource in a task state.
*)}Contains details about a task scheduled during an execution.
type nonrec task_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)resource : name;The action of the resource called by a task state.
*)resource_type : name;The service name of the resource in a task state.
*)}Contains details about a task failure event.
The activity does not exist.
Tags are key-value pairs that can be associated with Step Functions state machines and activities.
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
type nonrec tag_list = tag listtype nonrec tag_resource_input = {resource_arn : arn;The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
*)}type nonrec stop_execution_input = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)execution_arn : arn;The Amazon Resource Name (ARN) of the execution to stop.
*)}type nonrec kms_invalid_state_exception = {message : error_message option;kms_key_state : kms_key_state option;Current status of the KMS; key. For example: DISABLED, PENDING_DELETION, PENDING_IMPORT, UNAVAILABLE, CREATING.
}The KMS key is not in valid state, for example: Disabled or Deleted.
The specified execution does not exist.
type nonrec state_machine_version_list_item = {creation_date : timestamp;The creation date of a state machine version.
*)state_machine_version_arn : long_arn;The Amazon Resource Name (ARN) that identifies a state machine version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
}Contains details about a specific state machine version.
type nonrec state_machine_version_list = state_machine_version_list_item listState machine type is not supported.
type nonrec state_machine_list_item = {creation_date : timestamp;The date the state machine is created.
*)type_ : state_machine_type;name : name;The name of the state machine.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)state_machine_arn : arn;The Amazon Resource Name (ARN) that identifies the state machine.
*)}Contains details about the state machine.
type nonrec state_machine_list = state_machine_list_item listThe maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.
A state machine with the same name but a different definition or role ARN already exists.
type nonrec state_machine_alias_list_item = {creation_date : timestamp;The creation date of a state machine alias.
*)state_machine_alias_arn : long_arn;The Amazon Resource Name (ARN) that identifies a state machine alias. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.
}Contains details about a specific state machine alias.
type nonrec state_machine_alias_list = state_machine_alias_list_item listtype nonrec assigned_variables = (variable_name * variable_value) listtype nonrec assigned_variables_details = {truncated : truncated option;Indicates whether assigned variables were truncated in the response. Always false for API calls. In CloudWatch logs, the value will be true if the data is truncated due to size limits.
}Provides details about assigned variables in an execution history event.
type nonrec state_exited_event_details = {assigned_variables_details : assigned_variables_details option;Provides details about input or output in an execution history event.
*)assigned_variables : assigned_variables option;Map of variable name and value as a serialized JSON representation.
*)output_details : history_event_execution_data_details option;Contains details about the output of an execution history event.
*)output : sensitive_data option;The JSON output data of the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)name : name;The name of the state.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)}Contains details about an exit from a state during an execution.
type nonrec state_entered_event_details = {input_details : history_event_execution_data_details option;Contains details about the input for an execution history event.
*)input : sensitive_data option;The string that contains the JSON input data for the state. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)name : name;The name of the state.
*)}Contains details about a state entered during an execution.
type nonrec cloud_watch_events_execution_data_details = {included : included_details option;Indicates whether input or output was included in the response. Always true for API calls.
}Provides details about execution input or output.
type nonrec billing_details = {billed_duration_in_milliseconds : billed_duration option;Billed duration of your workflow, in milliseconds.
*)billed_memory_used_in_m_b : billed_memory_used option;Billed memory consumption of your workflow, in MB.
*)}An object that describes workflow billing details.
type nonrec start_sync_execution_output = {billing_details : billing_details option;An object that describes workflow billing details, including billed duration and memory use.
*)trace_header : trace_header option;The X-Ray trace header that was passed to the execution.
*)output_details : cloud_watch_events_execution_data_details option;output : sensitive_data option;The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
*)input_details : cloud_watch_events_execution_data_details option;input : sensitive_data option;The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)status : sync_execution_status;The current status of the execution.
*)stop_date : timestamp;If the execution has already ended, the date the execution stopped.
*)start_date : timestamp;The date the execution is started.
*)name : name option;The name of the execution.
*)state_machine_arn : arn option;The Amazon Resource Name (ARN) that identifies the state machine.
*)execution_arn : arn;The Amazon Resource Name (ARN) that identifies the execution.
*)}type nonrec start_sync_execution_input = {included_data : included_data option;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.
trace_header : trace_header option;Passes the X-Ray trace header. The trace header can also be passed in the request payload.
*)input : sensitive_data option;The string that contains the JSON input data for the execution, for example:
"input": "{\"first_name\" : \"test\"}"
If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"
Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)name : name option;The name of the execution.
*)state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine to execute.
*)}The provided name is not valid.
type nonrec start_execution_input = {trace_header : trace_header option;Passes the X-Ray trace header. The trace header can also be passed in the request payload.
*)input : sensitive_data option;The string that contains the JSON input data for the execution, for example:
"input": "{\"first_name\" : \"test\"}"
If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"
Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)name : name option;Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.
If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine to execute.
The stateMachineArn parameter accepts one of the following inputs:
An unqualified state machine ARN – Refers to a state machine ARN that isn't qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.
arn::states:::stateMachine:Step Functions doesn't associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.
A state machine version ARN – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10.
arn::states:::stateMachine::10Step Functions doesn't associate executions that you start with a version ARN with any aliases that point to that version.
A state machine alias ARN – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named PROD.
arn::states:::stateMachine:Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.
}The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.
The execution has the same name as another execution (but a different input).
Executions with the same name and input are considered idempotent.
type nonrec send_task_success_input = {output : sensitive_data;The JSON output of the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)task_token : task_token;The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
}The provided token is not valid.
The provided JSON output data is not valid.
type nonrec send_task_heartbeat_input = {task_token : task_token;The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
}type nonrec send_task_failure_input = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)task_token : task_token;The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
}type nonrec redrive_execution_output = {redrive_date : timestamp;The date the execution was last redriven.
*)}type nonrec redrive_execution_input = {client_token : client_token option;A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API will return idempotent responses for the last 10 client tokens used to successfully redrive the execution. These client tokens are valid for up to 15 minutes after they are first used.
*)execution_arn : arn;The Amazon Resource Name (ARN) of the execution to be redriven.
*)}The execution Amazon Resource Name (ARN) that you specified for executionArn cannot be redriven.
type nonrec publish_state_machine_version_input = {description : version_description option;An optional description of the state machine version.
*)revision_id : revision_id option;Only publish the state machine version if the current state machine's revision ID matches the specified ID.
Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn't match the state machine's current revision ID, the API returns ConflictException.
To specify an initial revision ID for a state machine with no revision ID assigned, specify the string INITIAL for the revisionId parameter. For example, you can specify a revisionID of INITIAL when you create a state machine using the CreateStateMachine API action.
state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine.
*)}type nonrec map_state_started_event_details = {length : unsigned_integer option;The size of the array for Map state iterations.
*)}Details about a Map state that was started.
type nonrec map_run_started_event_details = {map_run_arn : long_arn option;The Amazon Resource Name (ARN) of a Map Run that was started.
*)}Contains details about a Map Run that was started during a state machine execution.
type nonrec map_run_redriven_event_details = {redrive_count : redrive_count option;The number of times the Map Run has been redriven at this point in the execution's history including this event. The redrive count for a redriven Map Run is always greater than 0.
*)map_run_arn : long_arn option;The Amazon Resource Name (ARN) of a Map Run that was redriven.
*)}Contains details about a Map Run that was redriven.
type nonrec map_run_list_item = {stop_date : timestamp option;The date on which the Map Run stopped.
*)start_date : timestamp;The date on which the Map Run started.
*)state_machine_arn : arn;The Amazon Resource Name (ARN) of the executed state machine.
*)map_run_arn : long_arn;The Amazon Resource Name (ARN) of the Map Run.
*)execution_arn : arn;The executionArn of the execution from which the Map Run was started.
}Contains details about a specific Map Run.
type nonrec map_run_list = map_run_list_item listtype nonrec map_run_item_counts = {pending_redrive : long_object option;The number of unsuccessful items in child workflow executions currently waiting to be redriven.
*)failures_not_redrivable : long_object option;The number of FAILED, ABORTED, or TIMED_OUT items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.
results_written : unsigned_long;Returns the count of items whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.
total : unsigned_long;The total number of items processed in all the child workflow executions started by a Map Run.
*)aborted : unsigned_long;The total number of items processed in child workflow executions that were either stopped by the user or by Step Functions, because the Map Run failed.
*)timed_out : unsigned_long;The total number of items processed in child workflow executions that have timed out.
*)failed : unsigned_long;The total number of items processed in child workflow executions that have failed.
*)succeeded : unsigned_long;The total number of items processed in child workflow executions that have completed successfully.
*)running : unsigned_long;The total number of items being processed in child workflow executions that are currently in-progress.
*)pending : unsigned_long;The total number of items to process in child workflow executions that haven't started running yet.
*)}Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.
type nonrec map_run_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the Map Run failure.
*)}Contains details about a Map Run failure event that occurred during a state machine execution.
type nonrec map_run_execution_counts = {pending_redrive : long_object option;The number of unsuccessful child workflow executions currently waiting to be redriven. The status of these child workflow executions could be FAILED, ABORTED, or TIMED_OUT in the original execution attempt or a previous redrive attempt.
failures_not_redrivable : long_object option;The number of FAILED, ABORTED, or TIMED_OUT child workflow executions that cannot be redriven because their execution status is terminal. For example, child workflows with an execution status of FAILED, ABORTED, or TIMED_OUT and a redriveStatus of NOT_REDRIVABLE.
results_written : unsigned_long;Returns the count of child workflow executions whose results were written by ResultWriter. For more information, see ResultWriter in the Step Functions Developer Guide.
total : unsigned_long;The total number of child workflow executions that were started by a Map Run.
*)aborted : unsigned_long;The total number of child workflow executions that were started by a Map Run and were running, but were either stopped by the user or by Step Functions because the Map Run failed.
*)timed_out : unsigned_long;The total number of child workflow executions that were started by a Map Run and have timed out.
*)failed : unsigned_long;The total number of child workflow executions that were started by a Map Run, but have failed.
*)succeeded : unsigned_long;The total number of child workflow executions that were started by a Map Run and have completed successfully.
*)running : unsigned_long;The total number of child workflow executions that were started by a Map Run and are currently in-progress.
*)pending : unsigned_long;The total number of child workflow executions that were started by a Map Run, but haven't started executing yet.
*)}Contains details about all of the child workflow executions started by a Map Run.
type nonrec map_iteration_event_details = {index : unsigned_integer option;The index of the array belonging to the Map state iteration.
*)name : name option;The name of the iteration’s parent Map state.
*)}Contains details about an iteration of a Map state.
type nonrec list_state_machines_output = {next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
state_machines : state_machine_list;}type nonrec list_state_machines_input = {next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
max_results : page_size option;The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*)}type nonrec list_state_machine_versions_output = {next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
state_machine_versions : state_machine_version_list;Versions for the state machine.
*)}type nonrec list_state_machine_versions_input = {max_results : page_size option;The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*)next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine.
*)}type nonrec list_state_machine_aliases_output = {next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
state_machine_aliases : state_machine_alias_list;Aliases for the state machine.
*)}type nonrec list_state_machine_aliases_input = {max_results : page_size option;The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*)next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine for which you want to list aliases.
If you specify a state machine version ARN, this API returns a list of aliases for that version.
*)}type nonrec list_map_runs_output = {next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
map_runs : map_run_list;An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.
*)}type nonrec list_map_runs_input = {next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
max_results : page_size option;The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*)execution_arn : arn;The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.
*)}type nonrec execution_list_item = {redrive_date : timestamp option;The date the execution was last redriven.
*)redrive_count : redrive_count option;The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated when you successfully redrive an execution.
state_machine_alias_arn : arn option;The Amazon Resource Name (ARN) of the state machine alias used to start an execution.
If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.
*)state_machine_version_arn : arn option;The Amazon Resource Name (ARN) of the state machine version associated with the execution.
If the state machine execution was started with an unqualified ARN, it returns null.
If the execution was started using a stateMachineAliasArn, both the stateMachineAliasArn and stateMachineVersionArn parameters contain the respective values.
item_count : unsigned_integer option;The total number of items processed in a child workflow execution. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the itemCount field isn't returned.
map_run_arn : long_arn option;The Amazon Resource Name (ARN) of a Map Run. This field is returned only if mapRunArn was specified in the ListExecutions API action. If stateMachineArn was specified in ListExecutions, the mapRunArn isn't returned.
stop_date : timestamp option;If the execution already ended, the date the execution stopped.
*)start_date : timestamp;The date the execution started.
*)status : execution_status;The current status of the execution.
*)name : name;The name of the execution.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine that ran the execution.
*)execution_arn : arn;The Amazon Resource Name (ARN) that identifies the execution.
*)}Contains details about an execution.
type nonrec execution_list = execution_list_item listtype nonrec list_executions_output = {next_token : list_executions_page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
executions : execution_list;The list of matching executions.
*)}type nonrec list_executions_input = {redrive_filter : execution_redrive_filter option;Sets a filter to list executions based on whether or not they have been redriven.
For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.
If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.
If you provide a state machine ARN in redriveFilter, the API returns a validation exception.
map_run_arn : long_arn option;The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.
You can specify either a mapRunArn or a stateMachineArn, but not both.
next_token : list_executions_page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
max_results : page_size option;The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*)status_filter : execution_status option;If specified, only list the executions whose current execution status matches the given filter.
*)state_machine_arn : arn option;The Amazon Resource Name (ARN) of the state machine whose executions is listed.
You can specify either a mapRunArn or a stateMachineArn, but not both.
You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.
}type nonrec activity_list_item = {creation_date : timestamp;The date the activity is created.
*)name : name;The name of the activity.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)activity_arn : arn;The Amazon Resource Name (ARN) that identifies the activity.
*)}Contains details about an activity.
type nonrec activity_list = activity_list_item listtype nonrec list_activities_output = {next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
activities : activity_list;The list of activities.
*)}type nonrec list_activities_input = {next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
max_results : page_size option;The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*)}type nonrec lambda_function_timed_out_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the timeout.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about a Lambda function timeout that occurred during an execution.
type nonrec lambda_function_succeeded_event_details = {output_details : history_event_execution_data_details option;Contains details about the output of an execution history event.
*)output : sensitive_data option;The JSON data output by the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)}Contains details about a Lambda function that successfully terminated during an execution.
type nonrec lambda_function_start_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about a lambda function that failed to start during an execution.
type nonrec lambda_function_scheduled_event_details = {task_credentials : task_credentials option;The credentials that Step Functions uses for the task.
*)timeout_in_seconds : timeout_in_seconds option;The maximum allowed duration of the Lambda function.
*)input_details : history_event_execution_data_details option;Contains details about input for an execution history event.
*)input : sensitive_data option;The JSON data input to the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)resource : arn;The Amazon Resource Name (ARN) of the scheduled Lambda function.
*)}Contains details about a Lambda function scheduled during an execution.
type nonrec lambda_function_schedule_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about a failed Lambda function schedule event that occurred during an execution.
type nonrec lambda_function_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about a Lambda function that failed during an execution.
type nonrec history_event_type = | EvaluationFailed| MapRunRedriven| ExecutionRedriven| MapRunSucceeded| MapRunStarted| MapRunFailed| MapRunAborted| WaitStateExited| WaitStateEntered| WaitStateAborted| TaskTimedOut| TaskSucceeded| TaskSubmitted| TaskSubmitFailed| TaskStateExited| TaskStateEntered| TaskStateAborted| TaskStartFailed| TaskStarted| TaskScheduled| TaskFailed| SucceedStateExited| SucceedStateEntered| PassStateExited| PassStateEntered| ParallelStateSucceeded| ParallelStateStarted| ParallelStateFailed| ParallelStateExited| ParallelStateEntered| ParallelStateAborted| MapStateSucceeded| MapStateStarted| MapStateFailed| MapStateExited| MapStateEntered| MapStateAborted| MapIterationSucceeded| MapIterationStarted| MapIterationFailed| MapIterationAborted| LambdaFunctionTimedOut| LambdaFunctionSucceeded| LambdaFunctionStartFailed| LambdaFunctionStarted| LambdaFunctionScheduleFailed| LambdaFunctionScheduled| LambdaFunctionFailed| FailStateEntered| ExecutionTimedOut| ExecutionSucceeded| ExecutionStarted| ExecutionFailed| ExecutionAborted| ChoiceStateExited| ChoiceStateEntered| ActivityTimedOut| ActivitySucceeded| ActivityStarted| ActivityScheduleFailed| ActivityScheduled| ActivityFailedtype nonrec activity_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about an activity that failed during an execution.
type nonrec activity_schedule_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about an activity schedule failure that occurred during an execution.
type nonrec activity_scheduled_event_details = {heartbeat_in_seconds : timeout_in_seconds option;The maximum allowed duration between two heartbeats for the activity task.
*)timeout_in_seconds : timeout_in_seconds option;The maximum allowed duration of the activity task.
*)input_details : history_event_execution_data_details option;Contains details about the input for an execution history event.
*)input : sensitive_data option;The JSON data input to the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)resource : arn;The Amazon Resource Name (ARN) of the scheduled activity.
*)}Contains details about an activity scheduled during an execution.
type nonrec activity_started_event_details = {worker_name : identity option;The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.
}Contains details about the start of an activity during an execution.
type nonrec activity_succeeded_event_details = {output_details : history_event_execution_data_details option;Contains details about the output of an execution history event.
*)output : sensitive_data option;The JSON data output by the activity task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)}Contains details about an activity that successfully terminated during an execution.
type nonrec activity_timed_out_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the timeout.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about an activity timeout that occurred during an execution.
type nonrec execution_failed_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about an execution failure event.
type nonrec execution_started_event_details = {state_machine_version_arn : arn option;The Amazon Resource Name (ARN) that identifies a state machine version used for starting the state machine execution.
*)state_machine_alias_arn : arn option;The Amazon Resource Name (ARN) that identifies a state machine alias used for starting the state machine execution.
*)role_arn : arn option;The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.
*)input_details : history_event_execution_data_details option;Contains details about the input for an execution history event.
*)input : sensitive_data option;The JSON data input to the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)}Contains details about the start of the execution.
type nonrec execution_succeeded_event_details = {output_details : history_event_execution_data_details option;Contains details about the output of an execution history event.
*)output : sensitive_data option;The JSON data output by the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)}Contains details about the successful termination of the execution.
type nonrec execution_aborted_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about an abort of an execution.
type nonrec execution_timed_out_event_details = {cause : sensitive_cause option;A more detailed explanation of the cause of the timeout.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about the execution timeout that occurred during the execution.
type nonrec execution_redriven_event_details = {redrive_count : redrive_count option;The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is not updated for redrives that failed to start or are pending to be redriven.
}Contains details about a redriven execution.
type nonrec evaluation_failed_event_details = {state : state_name;The name of the state in which the evaluation error occurred.
*)location : evaluation_failure_location option;The location of the field in the state in which the evaluation error occurred.
*)cause : sensitive_cause option;A more detailed explanation of the cause of the failure.
*)error : sensitive_error option;The error code of the failure.
*)}Contains details about an evaluation failure that occurred while processing a state, for example, when a JSONata expression throws an error. This event will only be present in state machines that have QueryLanguage set to JSONata, or individual states set to JSONata.
type nonrec history_event = {evaluation_failed_event_details : evaluation_failed_event_details option;Contains details about an evaluation failure that occurred while processing a state.
*)map_run_redriven_event_details : map_run_redriven_event_details option;Contains details about the redrive attempt of a Map Run.
*)map_run_failed_event_details : map_run_failed_event_details option;Contains error and cause details about a Map Run that failed.
*)map_run_started_event_details : map_run_started_event_details option;Contains details, such as mapRunArn, and the start date and time of a Map Run. mapRunArn is the Amazon Resource Name (ARN) of the Map Run that was started.
state_exited_event_details : state_exited_event_details option;state_entered_event_details : state_entered_event_details option;lambda_function_timed_out_event_details : lambda_function_timed_out_event_details
option;lambda_function_succeeded_event_details : lambda_function_succeeded_event_details
option;Contains details about a Lambda function that terminated successfully during an execution.
*)lambda_function_start_failed_event_details : lambda_function_start_failed_event_details
option;Contains details about a lambda function that failed to start during an execution.
*)lambda_function_scheduled_event_details : lambda_function_scheduled_event_details
option;lambda_function_schedule_failed_event_details : lambda_function_schedule_failed_event_details
option;lambda_function_failed_event_details : lambda_function_failed_event_details
option;map_iteration_aborted_event_details : map_iteration_event_details option;Contains details about an iteration of a Map state that was aborted.
*)map_iteration_failed_event_details : map_iteration_event_details option;Contains details about an iteration of a Map state that failed.
*)map_iteration_succeeded_event_details : map_iteration_event_details option;Contains details about an iteration of a Map state that succeeded.
*)map_iteration_started_event_details : map_iteration_event_details option;Contains details about an iteration of a Map state that was started.
*)map_state_started_event_details : map_state_started_event_details option;Contains details about Map state that was started.
*)execution_redriven_event_details : execution_redriven_event_details option;Contains details about the redrive attempt of an execution.
*)execution_timed_out_event_details : execution_timed_out_event_details option;execution_aborted_event_details : execution_aborted_event_details option;execution_succeeded_event_details : execution_succeeded_event_details option;execution_started_event_details : execution_started_event_details option;execution_failed_event_details : execution_failed_event_details option;task_timed_out_event_details : task_timed_out_event_details option;Contains details about a task that timed out.
*)task_succeeded_event_details : task_succeeded_event_details option;Contains details about a task that succeeded.
*)task_submitted_event_details : task_submitted_event_details option;Contains details about a submitted task.
*)task_submit_failed_event_details : task_submit_failed_event_details option;Contains details about a task that where the submit failed.
*)task_started_event_details : task_started_event_details option;Contains details about a task that was started.
*)task_start_failed_event_details : task_start_failed_event_details option;Contains details about a task that failed to start.
*)task_scheduled_event_details : task_scheduled_event_details option;Contains details about a task that was scheduled.
*)task_failed_event_details : task_failed_event_details option;Contains details about the failure of a task.
*)activity_timed_out_event_details : activity_timed_out_event_details option;activity_succeeded_event_details : activity_succeeded_event_details option;activity_started_event_details : activity_started_event_details option;activity_scheduled_event_details : activity_scheduled_event_details option;activity_schedule_failed_event_details : activity_schedule_failed_event_details
option;Contains details about an activity schedule event that failed during an execution.
*)activity_failed_event_details : activity_failed_event_details option;previous_event_id : event_id option;The id of the previous event.
*)id : event_id;The id of the event. Events are numbered sequentially, starting at one.
*)type_ : history_event_type;The type of the event.
*)timestamp : timestamp;The date and time the event occurred.
*)}Contains details about the events of an execution.
type nonrec history_event_list = history_event listtype nonrec get_execution_history_output = {next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
events : history_event_list;The list of events that occurred in the execution.
*)}type nonrec get_execution_history_input = {include_execution_data : include_execution_data_get_execution_history option;You can select whether execution data (input or output of a history event) is returned. The default is true.
next_token : page_token option;If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
reverse_order : reverse_order option;Lists events in descending order of their timeStamp.
max_results : page_size option;The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
*)execution_arn : arn;The Amazon Resource Name (ARN) of the execution.
*)}type nonrec get_activity_task_output = {input : sensitive_data_job_input option;The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)task_token : task_token option;A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.
}type nonrec get_activity_task_input = {worker_name : name option;You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.
*)activity_arn : arn;The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)
}The maximum number of workers concurrently polling for activity tasks has been reached.
The specified activity does not exist.
type nonrec describe_state_machine_output = {variable_references : variable_references option;A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.
*)encryption_configuration : encryption_configuration option;Settings to configure server-side encryption.
*)description : version_description option;The description of the state machine version.
*)revision_id : revision_id option;The revision identifier for the state machine.
Use the revisionId parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition and roleArn.
label : map_run_label option;A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.
tracing_configuration : tracing_configuration option;Selects whether X-Ray tracing is enabled.
*)logging_configuration : logging_configuration option;creation_date : timestamp;The date the state machine is created.
For a state machine version, creationDate is the date the version was created.
type_ : state_machine_type;The type of the state machine (STANDARD or EXPRESS).
role_arn : arn;The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)
*)definition : definition;The Amazon States Language definition of the state machine. See Amazon States Language.
If called with includedData = METADATA_ONLY, the returned definition will be {}.
status : state_machine_status option;The current status of the state machine.
*)name : name;The name of the state machine.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)state_machine_arn : arn;The Amazon Resource Name (ARN) that identifies the state machine.
If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
}type nonrec describe_state_machine_input = {included_data : included_data option;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.
When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt permission.
state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine for which you want the information.
If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
}type nonrec describe_state_machine_for_execution_output = {variable_references : variable_references option;A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.
*)encryption_configuration : encryption_configuration option;Settings to configure server-side encryption.
*)revision_id : revision_id option;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.
label : map_run_label option;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.
map_run_arn : long_arn option;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.
tracing_configuration : tracing_configuration option;Selects whether X-Ray tracing is enabled.
*)logging_configuration : logging_configuration option;update_date : timestamp;The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
*)role_arn : arn;The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
*)definition : definition;name : name;The name of the state machine associated with the execution.
*)state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine associated with the execution.
*)}type nonrec describe_state_machine_for_execution_input = {included_data : included_data option;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.
execution_arn : arn;The Amazon Resource Name (ARN) of the execution you want state machine information for.
*)}type nonrec describe_state_machine_alias_output = {update_date : timestamp option;The date the state machine alias was last updated.
For a newly created state machine, this is the same as the creation date.
*)creation_date : timestamp option;The date the state machine alias was created.
*)routing_configuration : routing_configuration_list option;The routing configuration of the alias.
*)description : alias_description option;A description of the alias.
*)name : name option;The name of the state machine alias.
*)state_machine_alias_arn : arn option;The Amazon Resource Name (ARN) of the state machine alias.
*)}type nonrec describe_state_machine_alias_input = {state_machine_alias_arn : arn;The Amazon Resource Name (ARN) of the state machine alias.
*)}type nonrec describe_map_run_output = {redrive_date : timestamp option;The date a Map Run was last redriven. If you have not yet redriven a Map Run, the redriveDate is null.
redrive_count : redrive_count option;The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the redriveCount is 0. This count is only updated if you successfully redrive a Map Run.
execution_counts : map_run_execution_counts;A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as failed and succeeded.
item_counts : map_run_item_counts;A JSON object that contains information about the total number of items, and the item count for each processing status, such as pending and failed.
tolerated_failure_count : tolerated_failure_count;The maximum number of failed child workflow executions before the Map Run fails.
*)tolerated_failure_percentage : tolerated_failure_percentage;The maximum percentage of failed child workflow executions before the Map Run fails.
*)max_concurrency : max_concurrency;The maximum number of child workflow executions configured to run in parallel for the Map Run at the same time.
*)stop_date : timestamp option;The date when the Map Run was stopped.
*)start_date : timestamp;The date when the Map Run was started.
*)status : map_run_status;The current status of the Map Run.
*)execution_arn : arn;The Amazon Resource Name (ARN) that identifies the execution in which the Map Run was started.
*)map_run_arn : long_arn;The Amazon Resource Name (ARN) that identifies a Map Run.
*)}type nonrec describe_map_run_input = {map_run_arn : long_arn;The Amazon Resource Name (ARN) that identifies a Map Run.
*)}type nonrec describe_execution_output = {redrive_status_reason : sensitive_data option;When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.
For executions of type STANDARD, or for a Distributed Map that includes child workflows of type STANDARD, redriveStatusReason can include one of the following reasons:
State machine is in DELETING status.Execution is RUNNING and cannot be redriven.Execution is SUCCEEDED and cannot be redriven.Execution was started before the launch of RedriveExecution.Execution history event limit exceeded.Execution has exceeded the max execution time.Execution redrivable period exceeded.EXPRESS, redriveStatusReason is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.redrive_status : execution_redrive_status option;Indicates whether or not an execution can be redriven at a given point in time.
STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.
You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.
redrive_date : timestamp option;The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.
The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.
redrive_count : redrive_count option;The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.
state_machine_alias_arn : arn option;The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.
If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.
state_machine_version_arn : arn option;The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.
If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.
cause : sensitive_cause option;The cause string if the state machine execution failed.
*)error : sensitive_error option;The error string if the state machine execution failed.
*)map_run_arn : long_arn option;The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
*)trace_header : trace_header option;The X-Ray trace header that was passed to the execution.
*)output_details : cloud_watch_events_execution_data_details option;output : sensitive_data option;The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
This field is set only if the execution succeeds. If the execution fails, this field is null.
*)input_details : cloud_watch_events_execution_data_details option;input : sensitive_data option;The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
*)stop_date : timestamp option;If the execution ended, the date the execution stopped.
*)start_date : timestamp;The date the execution is started.
*)status : execution_status;The current status of the execution.
*)name : name option;The name of the execution.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)state_machine_arn : arn;The Amazon Resource Name (ARN) of the executed stated machine.
*)execution_arn : arn;The Amazon Resource Name (ARN) that identifies the execution.
*)}type nonrec describe_execution_input = {included_data : included_data option;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 DescribeStateMachine API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.
execution_arn : arn;The Amazon Resource Name (ARN) of the execution to describe.
*)}type nonrec describe_activity_output = {encryption_configuration : encryption_configuration option;Settings for configured server-side encryption.
*)creation_date : timestamp;The date the activity is created.
*)name : name;The name of the activity.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)activity_arn : arn;The Amazon Resource Name (ARN) that identifies the activity.
*)}type nonrec describe_activity_input = {activity_arn : arn;The Amazon Resource Name (ARN) of the activity to describe.
*)}type nonrec delete_state_machine_version_input = {state_machine_version_arn : long_arn;The Amazon Resource Name (ARN) of the state machine version to delete.
*)}type nonrec delete_state_machine_input = {state_machine_arn : arn;The Amazon Resource Name (ARN) of the state machine to delete.
*)}type nonrec delete_state_machine_alias_input = {state_machine_alias_arn : arn;The Amazon Resource Name (ARN) of the state machine alias to delete.
*)}type nonrec delete_activity_input = {activity_arn : arn;The Amazon Resource Name (ARN) of the activity to delete.
*)}type nonrec create_state_machine_output = {state_machine_version_arn : arn option;The Amazon Resource Name (ARN) that identifies the created state machine version. If you do not set the publish parameter to true, this field returns null value.
creation_date : timestamp;The date the state machine is created.
*)state_machine_arn : arn;The Amazon Resource Name (ARN) that identifies the created state machine.
*)}type nonrec create_state_machine_input = {encryption_configuration : encryption_configuration option;Settings to configure server-side encryption.
*)version_description : version_description option;Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
publish : publish option;Set to true to publish the first version of the state machine during creation. The default is false.
tracing_configuration : tracing_configuration option;Selects whether X-Ray tracing is enabled.
*)logging_configuration : logging_configuration option;Defines what execution history events are logged and where they are logged.
By default, the level is set to OFF. For more information see Log Levels in the Step Functions User Guide.
type_ : state_machine_type option;Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created.
role_arn : arn;The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
*)definition : definition;name : name;The name of the state machine.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)}type nonrec create_state_machine_alias_input = {routing_configuration : routing_configuration_list;The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig.
name : character_restricted_name;The name of the state machine alias.
To avoid conflict with version ARNs, don't use an integer in the name of the alias.
*)description : alias_description option;A description for the state machine alias.
*)}type nonrec create_activity_input = {encryption_configuration : encryption_configuration option;Settings to configure server-side encryption.
*)name : name;The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information, see Limits Related to State Machine Executions in the Step Functions Developer Guide.
A name must not contain:
< > { } [ ]? *" # % \ ^ | ~ ` $ & , ; : /U+0000-001F, U+007F-009F)To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
*)}The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.
Activity already exists. EncryptionConfiguration may not be updated.