Values (p.awso.0.9.1.doc.awso.stepfunctions.Awso

Sourceval service : Awso.Service.t

Sourceval apiVersion : string

Sourceval endpointPrefix : string

Sourceval serviceFullName : string

Sourceval signatureVersion : string

Sourceval protocol : string

Sourceval globalEndpoint : string

Sourceval serviceAbbreviation : string

Sourceval targetPrefix : string

Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t

Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule Arn : sig ... end

Sourcemodule Truncated : sig ... end

Sourcemodule LongArn : sig ... end

Sourcemodule VariableName : sig ... end

Sourcemodule VariableValue : sig ... end

Sourcemodule CloudWatchLogsLogGroup : sig ... end

Sourcemodule SensitiveCause : sig ... end

Sourcemodule SensitiveError : sig ... end

Sourcemodule HistoryEventExecutionDataDetails : sig ... end

Provides details about input or output in an execution history event.

Sourcemodule SensitiveData : sig ... end

Sourcemodule TimeoutInSeconds : sig ... end

Sourcemodule Identity : sig ... end

Sourcemodule EvaluationFailureLocation : sig ... end

Sourcemodule StateName : sig ... end

Sourcemodule RedriveCount : sig ... end

Sourcemodule TaskCredentials : sig ... end

Contains details about the credentials that Step Functions uses for a task.

Sourcemodule Name : sig ... end

Sourcemodule UnsignedInteger : sig ... end

Sourcemodule AssignedVariables : sig ... end

Sourcemodule AssignedVariablesDetails : sig ... end

Provides details about assigned variables in an execution history event.

Sourcemodule ConnectorParameters : sig ... end

Sourcemodule ValidateStateMachineDefinitionCode : sig ... end

Sourcemodule ValidateStateMachineDefinitionLocation : sig ... end

Sourcemodule ValidateStateMachineDefinitionMessage : sig ... end

Sourcemodule ValidateStateMachineDefinitionSeverity : sig ... end

Sourcemodule LogDestination : sig ... end

Sourcemodule VersionWeight : sig ... end

Sourcemodule HTTPBody : sig ... end

Sourcemodule HTTPHeaders : sig ... end

Sourcemodule HTTPMethod : sig ... end

Sourcemodule HTTPProtocol : sig ... end

Sourcemodule URL : sig ... end

Sourcemodule HTTPStatusCode : sig ... end

Sourcemodule HTTPStatusMessage : sig ... end

Sourcemodule ExceptionHandlerIndex : sig ... end

Sourcemodule RetryBackoffIntervalSeconds : sig ... end

Sourcemodule TagKey : sig ... end

Sourcemodule TagValue : sig ... end

Sourcemodule StateMachineType : sig ... end

Sourcemodule Timestamp : sig ... end

Sourcemodule ExecutionStatus : sig ... end

Sourcemodule ActivityFailedEventDetails : sig ... end

Contains details about an activity that failed during an execution.

Sourcemodule ActivityScheduleFailedEventDetails : sig ... end

Contains details about an activity schedule failure that occurred during an execution.

Sourcemodule ActivityScheduledEventDetails : sig ... end

Contains details about an activity scheduled during an execution.

Sourcemodule ActivityStartedEventDetails : sig ... end

Contains details about the start of an activity during an execution.

Sourcemodule ActivitySucceededEventDetails : sig ... end

Contains details about an activity that successfully terminated during an execution.

Sourcemodule ActivityTimedOutEventDetails : sig ... end

Contains details about an activity timeout that occurred during an execution.

Sourcemodule EvaluationFailedEventDetails : sig ... end

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.

Sourcemodule EventId : sig ... end

Sourcemodule ExecutionAbortedEventDetails : sig ... end

Contains details about an abort of an execution.

Sourcemodule ExecutionFailedEventDetails : sig ... end

Contains details about an execution failure event.

Sourcemodule ExecutionRedrivenEventDetails : sig ... end

Contains details about a redriven execution.

Sourcemodule ExecutionStartedEventDetails : sig ... end

Contains details about the start of the execution.

Sourcemodule ExecutionSucceededEventDetails : sig ... end

Contains details about the successful termination of the execution.

Sourcemodule ExecutionTimedOutEventDetails : sig ... end

Contains details about the execution timeout that occurred during the execution.

Sourcemodule HistoryEventType : sig ... end

Sourcemodule LambdaFunctionFailedEventDetails : sig ... end

Contains details about a Lambda function that failed during an execution.

Sourcemodule LambdaFunctionScheduleFailedEventDetails : sig ... end

Contains details about a failed Lambda function schedule event that occurred during an execution.

Sourcemodule LambdaFunctionScheduledEventDetails : sig ... end

Contains details about a Lambda function scheduled during an execution.

Sourcemodule LambdaFunctionStartFailedEventDetails : sig ... end

Contains details about a lambda function that failed to start during an execution.

Sourcemodule LambdaFunctionSucceededEventDetails : sig ... end

Contains details about a Lambda function that successfully terminated during an execution.

Sourcemodule LambdaFunctionTimedOutEventDetails : sig ... end

Contains details about a Lambda function timeout that occurred during an execution.

Sourcemodule MapIterationEventDetails : sig ... end

Contains details about an iteration of a Map state.

Sourcemodule MapRunFailedEventDetails : sig ... end

Contains details about a Map Run failure event that occurred during a state machine execution.

Sourcemodule MapRunRedrivenEventDetails : sig ... end

Contains details about a Map Run that was redriven.

Sourcemodule MapRunStartedEventDetails : sig ... end

Contains details about a Map Run that was started during a state machine execution.

Sourcemodule MapStateStartedEventDetails : sig ... end

Details about a Map state that was started.

Sourcemodule StateEnteredEventDetails : sig ... end

Contains details about a state entered during an execution.

Sourcemodule StateExitedEventDetails : sig ... end

Contains details about an exit from a state during an execution.

Sourcemodule TaskFailedEventDetails : sig ... end

Contains details about a task failure event.

Sourcemodule TaskScheduledEventDetails : sig ... end

Contains details about a task scheduled during an execution.

Sourcemodule TaskStartFailedEventDetails : sig ... end

Contains details about a task that failed to start during an execution.

Sourcemodule TaskStartedEventDetails : sig ... end

Contains details about the start of a task during an execution.

Sourcemodule TaskSubmitFailedEventDetails : sig ... end

Contains details about a task that failed to submit during an execution.

Sourcemodule TaskSubmittedEventDetails : sig ... end

Contains details about a task submitted to a resource .

Sourcemodule TaskSucceededEventDetails : sig ... end

Contains details about the successful completion of a task state.

Sourcemodule TaskTimedOutEventDetails : sig ... end

Contains details about a resource timeout that occurred during an execution.

Sourcemodule ValidateStateMachineDefinitionDiagnostic : sig ... end

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.

Sourcemodule ErrorMessage : sig ... end

Sourcemodule ValidationExceptionReason : sig ... end

Sourcemodule EncryptionType : sig ... end

Sourcemodule KmsDataKeyReusePeriodSeconds : sig ... end

Sourcemodule KmsKeyId : sig ... end

Sourcemodule IncludeExecutionData : sig ... end

Sourcemodule LogDestinationList : sig ... end

Sourcemodule LogLevel : sig ... end

Sourcemodule Enabled : sig ... end

Sourcemodule RoutingConfigurationListItem : sig ... end

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.

Sourcemodule InspectionDataRequest : sig ... end

Contains additional details about the state's execution, including its input and output data processing flow, and HTTP request information.

Sourcemodule InspectionDataResponse : sig ... end

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.

Sourcemodule InspectionErrorDetails : sig ... end

An object containing data about a handled exception in the tested state.

Sourcemodule InspectionMaxConcurrency : sig ... end

Sourcemodule InspectionToleratedFailureCount : sig ... end

Sourcemodule InspectionToleratedFailurePercentage : sig ... end

Sourcemodule MockErrorOutput : sig ... end

A JSON object that contains a mocked error.

Sourcemodule MockResponseValidationMode : sig ... end

Sourcemodule MapIterationFailureCount : sig ... end

Sourcemodule RetrierRetryCount : sig ... end

Sourcemodule TestStateStateName : sig ... end

Sourcemodule Tag : sig ... end

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: _ . : / = + - @.

Sourcemodule KmsKeyState : sig ... end

Sourcemodule BilledDuration : sig ... end

Sourcemodule BilledMemoryUsed : sig ... end

Sourcemodule IncludedDetails : sig ... end

Sourcemodule StateMachineListItem : sig ... end

Contains details about the state machine.

Sourcemodule StateMachineVersionListItem : sig ... end

Contains details about a specific state machine version.

Sourcemodule StateMachineAliasListItem : sig ... end

Contains details about a specific state machine alias.

Sourcemodule MapRunListItem : sig ... end

Contains details about a specific Map Run.

Sourcemodule ExecutionListItem : sig ... end

Contains details about an execution.

Sourcemodule ActivityListItem : sig ... end

Contains details about an activity.

Sourcemodule HistoryEvent : sig ... end

Contains details about the events of an execution.

Sourcemodule VariableNameList : sig ... end

Sourcemodule LongObject : sig ... end

Sourcemodule UnsignedLong : sig ... end

Sourcemodule ValidateStateMachineDefinitionDiagnosticList : sig ... end

Sourcemodule ValidateStateMachineDefinitionResultCode : sig ... end

Sourcemodule ValidateStateMachineDefinitionTruncated : sig ... end

Sourcemodule ValidationException : sig ... end

The input does not satisfy the constraints specified by an Amazon Web Services service.

Sourcemodule Definition : sig ... end

Sourcemodule ValidateStateMachineDefinitionMaxResult : sig ... end

Sourcemodule ConflictException : sig ... end

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

Sourcemodule InvalidArn : sig ... end

The provided Amazon Resource Name (ARN) is not valid.

Sourcemodule InvalidDefinition : sig ... end

The provided Amazon States Language definition is not valid.

Sourcemodule InvalidEncryptionConfiguration : sig ... end

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.

Sourcemodule InvalidLoggingConfiguration : sig ... end

Configuration is not valid.

Sourcemodule InvalidTracingConfiguration : sig ... end

Your tracingConfiguration key does not match, or enabled has not been set to true or false.

Sourcemodule KmsAccessDeniedException : sig ... end

Either your KMS key policy or API caller does not have the required permissions.

Sourcemodule KmsThrottlingException : sig ... end

Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.

Sourcemodule MissingRequiredParameter : sig ... end

Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.

Sourcemodule RevisionId : sig ... end

Sourcemodule ServiceQuotaExceededException : sig ... end

The request would cause a service quota to be exceeded. HTTP Status Code: 402

Sourcemodule StateMachineDeleting : sig ... end

The specified state machine is being deleted.

Sourcemodule StateMachineDoesNotExist : sig ... end

The specified state machine does not exist.

Sourcemodule EncryptionConfiguration : sig ... end

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?

Sourcemodule LoggingConfiguration : sig ... end

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

Sourcemodule Publish : sig ... end

Sourcemodule TracingConfiguration : sig ... end

Selects whether or not the state machine's X-Ray tracing is enabled. Default is false

Sourcemodule VersionDescription : sig ... end

Sourcemodule ResourceNotFound : sig ... end

Could not find the referenced resource.

Sourcemodule AliasDescription : sig ... end

Sourcemodule RoutingConfigurationList : sig ... end

Sourcemodule MaxConcurrency : sig ... end

Sourcemodule ToleratedFailureCount : sig ... end

Sourcemodule ToleratedFailurePercentage : sig ... end

Sourcemodule TagKeyList : sig ... end

Sourcemodule InspectionData : sig ... end

Contains additional details about the state's execution, including its input and output data processing flow, and HTTP request and response information.

Sourcemodule InvalidExecutionInput : sig ... end

The provided JSON input data is not valid.

Sourcemodule TestExecutionStatus : sig ... end

Sourcemodule InspectionLevel : sig ... end

Sourcemodule MockInput : sig ... end

A JSON object that contains a mocked result or errorOutput.

Sourcemodule RevealSecrets : sig ... end

Sourcemodule TestStateConfiguration : sig ... end

Contains configurations for the tested state.

Sourcemodule TooManyTags : sig ... end

You've exceeded the number of tags allowed for a resource. See the Limits Topic in the Step Functions Developer Guide.

Sourcemodule TagList : sig ... end

Sourcemodule ExecutionDoesNotExist : sig ... end

The specified execution does not exist.

Sourcemodule KmsInvalidStateException : sig ... end

The KMS key is not in valid state, for example: Disabled or Deleted.

Sourcemodule BillingDetails : sig ... end

An object that describes workflow billing details.

Sourcemodule CloudWatchEventsExecutionDataDetails : sig ... end

Provides details about execution input or output.

Sourcemodule InvalidName : sig ... end

The provided name is not valid.

Sourcemodule StateMachineTypeNotSupported : sig ... end

State machine type is not supported.

Sourcemodule SyncExecutionStatus : sig ... end

Sourcemodule TraceHeader : sig ... end

Sourcemodule IncludedData : sig ... end

Sourcemodule ExecutionAlreadyExists : sig ... end

The execution has the same name as another execution (but a different input). Executions with the same name and input are considered idempotent.

Sourcemodule ExecutionLimitExceeded : sig ... end

The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.

Sourcemodule InvalidOutput : sig ... end

The provided JSON output data is not valid.

Sourcemodule InvalidToken : sig ... end

The provided token is not valid.

Sourcemodule TaskDoesNotExist : sig ... end

The activity does not exist.

Sourcemodule TaskTimedOut : sig ... end

The task token has either expired or the task associated with the token has already been closed.

Sourcemodule TaskToken : sig ... end

Sourcemodule ExecutionNotRedrivable : sig ... end

The execution Amazon Resource Name (ARN) that you specified for executionArn cannot be redriven.

Sourcemodule ClientToken : sig ... end

Sourcemodule PageToken : sig ... end

Sourcemodule StateMachineList : sig ... end

Sourcemodule PageSize : sig ... end

Sourcemodule StateMachineVersionList : sig ... end

Sourcemodule StateMachineAliasList : sig ... end

Sourcemodule MapRunList : sig ... end

Sourcemodule ExecutionList : sig ... end

Sourcemodule ListExecutionsPageToken : sig ... end

Sourcemodule ExecutionRedriveFilter : sig ... end

Sourcemodule ActivityList : sig ... end

Sourcemodule HistoryEventList : sig ... end

Sourcemodule IncludeExecutionDataGetExecutionHistory : sig ... end

Sourcemodule ReverseOrder : sig ... end

Sourcemodule ActivityDoesNotExist : sig ... end

The specified activity does not exist.

Sourcemodule ActivityWorkerLimitExceeded : sig ... end

The maximum number of workers concurrently polling for activity tasks has been reached.

Sourcemodule SensitiveDataJobInput : sig ... end

Sourcemodule MapRunLabel : sig ... end

Sourcemodule StateMachineStatus : sig ... end

Sourcemodule VariableReferences : sig ... end

Sourcemodule MapRunExecutionCounts : sig ... end

Contains details about all of the child workflow executions started by a Map Run.

Sourcemodule MapRunItemCounts : sig ... end

Contains details about items that were processed in all of the child workflow executions that were started by a Map Run.

Sourcemodule MapRunStatus : sig ... end

Sourcemodule ExecutionRedriveStatus : sig ... end

Sourcemodule StateMachineAlreadyExists : sig ... end

A state machine with the same name but a different definition or role ARN already exists.

Sourcemodule StateMachineLimitExceeded : sig ... end

The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.

Sourcemodule CharacterRestrictedName : sig ... end

Sourcemodule ActivityAlreadyExists : sig ... end

Activity already exists. EncryptionConfiguration may not be updated.

Sourcemodule ActivityLimitExceeded : sig ... end

The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.

Sourcemodule ValidateStateMachineDefinitionOutput : sig ... end

Validates the syntax of a state machine definition specified in Amazon States Language (ASL), a JSON-based, structured language. You can validate that a state machine definition is correct without creating a state machine resource. Suggested uses for ValidateStateMachineDefinition: Integrate automated checks into your code review or Continuous Integration (CI) process to check state machine definitions before starting deployments. Run validation from a Git pre-commit hook to verify the definition before committing to your source repository. Validation will look for problems in your state machine definition and return a result and a list of diagnostic elements. The result value will be OK when your workflow definition can be successfully created or updated. Note the result can be OK even when diagnostic warnings are present in the response. The result value will be FAIL when the workflow definition contains errors that would prevent you from creating or updating your state machine. The list of ValidateStateMachineDefinitionDiagnostic data elements can contain zero or more WARNING and/or ERROR elements. The ValidateStateMachineDefinition API 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.

Sourcemodule ValidateStateMachineDefinitionInput : sig ... end

Validates the syntax of a state machine definition specified in Amazon States Language (ASL), a JSON-based, structured language. You can validate that a state machine definition is correct without creating a state machine resource. Suggested uses for ValidateStateMachineDefinition: Integrate automated checks into your code review or Continuous Integration (CI) process to check state machine definitions before starting deployments. Run validation from a Git pre-commit hook to verify the definition before committing to your source repository. Validation will look for problems in your state machine definition and return a result and a list of diagnostic elements. The result value will be OK when your workflow definition can be successfully created or updated. Note the result can be OK even when diagnostic warnings are present in the response. The result value will be FAIL when the workflow definition contains errors that would prevent you from creating or updating your state machine. The list of ValidateStateMachineDefinitionDiagnostic data elements can contain zero or more WARNING and/or ERROR elements. The ValidateStateMachineDefinition API 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.

Sourcemodule UpdateStateMachineOutput : sig ... end

Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine. Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1. All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.

Sourcemodule UpdateStateMachineInput : sig ... end

Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine. Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1. All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.

Sourcemodule UpdateStateMachineAliasOutput : sig ... end

Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration. You must specify at least one of the description or routingConfiguration parameters to update a state machine alias. UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response. This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration. Related operations: CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases DeleteStateMachineAlias

Sourcemodule UpdateStateMachineAliasInput : sig ... end

Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration. You must specify at least one of the description or routingConfiguration parameters to update a state machine alias. UpdateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineAliasArn, description, and routingConfiguration parameters. Requests with the same parameters return an idempotent response. This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling UpdateStateMachineAlias may use the previous routing configuration. Related operations: CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases DeleteStateMachineAlias

Sourcemodule UpdateMapRunOutput : sig ... end

Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

Sourcemodule UpdateMapRunInput : sig ... end

Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.

Sourcemodule UntagResourceOutput : sig ... end

Remove a tag from a Step Functions resource

Sourcemodule UntagResourceInput : sig ... end

Remove a tag from a Step Functions resource

Sourcemodule TestStateOutput : sig ... end

Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following: A state's input and output processing data flow An Amazon Web Services service integration request and response An HTTP Task request and response You can call this API on only one state at a time. The states that you can test include the following: All Task types except Activity Pass Wait Choice Succeed Fail The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state. The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the States.Timeout error. TestState only supports the following when a mock is specified: Activity tasks, .sync or .waitForTaskToken service integration patterns, Parallel, or Map states.

Sourcemodule TestStateInput : sig ... end

Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following: A state's input and output processing data flow An Amazon Web Services service integration request and response An HTTP Task request and response You can call this API on only one state at a time. The states that you can test include the following: All Task types except Activity Pass Wait Choice Succeed Fail The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state. The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the States.Timeout error. TestState only supports the following when a mock is specified: Activity tasks, .sync or .waitForTaskToken service integration patterns, Parallel, or Map states.

Sourcemodule TagResourceOutput : sig ... end

Add a tag to a Step Functions resource. 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: _ . : / = + - @.

Sourcemodule TagResourceInput : sig ... end

Add a tag to a Step Functions resource. 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: _ . : / = + - @.

Sourcemodule StopExecutionOutput : sig ... end

Stops an execution. This API action is not supported by EXPRESS state machines. For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role. A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Sourcemodule StopExecutionInput : sig ... end

Stops an execution. This API action is not supported by EXPRESS state machines. For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role. A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Sourcemodule StartSyncExecutionOutput : sig ... end

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows. StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration. This API action isn't logged in CloudTrail.

Sourcemodule StartSyncExecutionInput : sig ... end

Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows. StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration. This API action isn't logged in CloudTrail.

Sourcemodule StartExecutionOutput : sig ... end

Starts a state machine execution. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution. To start executions of a state machine version, call StartExecution and provide the version ARN or the ARN of an alias that points to the version. StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if you call StartExecution with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days. StartExecution isn't idempotent for EXPRESS workflows.

Sourcemodule StartExecutionInput : sig ... end

Starts a state machine execution. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution. To start executions of a state machine version, call StartExecution and provide the version ARN or the ARN of an alias that points to the version. StartExecution is idempotent for STANDARD workflows. For a STANDARD workflow, if you call StartExecution with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a 400 ExecutionAlreadyExists error. You can reuse names after 90 days. StartExecution isn't idempotent for EXPRESS workflows.

Sourcemodule SendTaskSuccessOutput : sig ... end

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken completed successfully.

Sourcemodule SendTaskSuccessInput : sig ... end

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken completed successfully.

Sourcemodule SendTaskHeartbeatOutput : sig ... end

Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

Sourcemodule SendTaskHeartbeatInput : sig ... end

Used by activity workers and Task states using the callback pattern, and optionally Task states using the job run pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

Sourcemodule SendTaskFailureOutput : sig ... end

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed. For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role. A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Sourcemodule SendTaskFailureInput : sig ... end

Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run pattern to report that the task identified by the taskToken failed. For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role. A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both error and cause fields because no data needs to be encrypted.

Sourcemodule RedriveExecutionOutput : sig ... end

Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt. For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted. To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run. This API action is not supported by EXPRESS state machines. However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs. You can redrive executions if your original execution meets the following conditions: The execution status isn't SUCCEEDED. Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution. The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions. The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the ExecutionRedriven history event and at least one other history event.

Sourcemodule RedriveExecutionInput : sig ... end

Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you redrive an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt. For workflows that include an Inline Map or Parallel state, RedriveExecution API action reschedules and redrives only the iterations and branches that failed or aborted. To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the parent workflow. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run. This API action is not supported by EXPRESS state machines. However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see Redriving Map Runs. You can redrive executions if your original execution meets the following conditions: The execution status isn't SUCCEEDED. Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution. The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see Quotas related to state machine executions. The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the ExecutionRedriven history event and at least one other history event.

Sourcemodule PublishStateMachineVersionOutput : sig ... end

Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias. You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action. PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision. Related operations: DeleteStateMachineVersion ListStateMachineVersions

Sourcemodule PublishStateMachineVersionInput : sig ... end

Creates a version from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias. You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action. PublishStateMachineVersion is an idempotent API. It doesn't create a duplicate state machine version if it already exists for the current revision. Step Functions bases PublishStateMachineVersion's idempotency check on the stateMachineArn, name, and revisionId parameters. Requests with the same parameters return a successful idempotent response. If you don't specify a revisionId, Step Functions checks for a previously published version of the state machine's current revision. Related operations: DeleteStateMachineVersion ListStateMachineVersions

Sourcemodule ListTagsForResourceOutput : sig ... end

List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

Sourcemodule ListTagsForResourceInput : sig ... end

List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

Sourcemodule ListStateMachinesOutput : sig ... end

Lists the existing state machines. 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. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Sourcemodule ListStateMachinesInput : sig ... end

Lists the existing state machines. 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. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Sourcemodule ListStateMachineVersionsOutput : sig ... end

Lists versions for the specified state machine Amazon Resource Name (ARN). The results are sorted in descending order of the version creation time. 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. Related operations: PublishStateMachineVersion DeleteStateMachineVersion

Sourcemodule ListStateMachineVersionsInput : sig ... end

Lists versions for the specified state machine Amazon Resource Name (ARN). The results are sorted in descending order of the version creation time. 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. Related operations: PublishStateMachineVersion DeleteStateMachineVersion

Sourcemodule ListStateMachineAliasesOutput : sig ... end

Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter. 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. Related operations: CreateStateMachineAlias DescribeStateMachineAlias UpdateStateMachineAlias DeleteStateMachineAlias

Sourcemodule ListStateMachineAliasesInput : sig ... end

Lists aliases for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first. To list aliases that reference a state machine version, you can specify the version ARN in the stateMachineArn parameter. 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. Related operations: CreateStateMachineAlias DescribeStateMachineAlias UpdateStateMachineAlias DeleteStateMachineAlias

Sourcemodule ListMapRunsOutput : sig ... end

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

Sourcemodule ListMapRunsInput : sig ... end

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

Sourcemodule ListExecutionsOutput : sig ... end

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions. You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version. Results are sorted by time, with the most recent execution first. 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. 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.

Sourcemodule ListExecutionsInput : sig ... end

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all redriven executions. You can also provide a state machine alias ARN or version ARN to list the executions associated with a specific alias or version. Results are sorted by time, with the most recent execution first. 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. 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.

Sourcemodule ListActivitiesOutput : sig ... end

Lists the existing activities. 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. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Sourcemodule ListActivitiesInput : sig ... end

Lists the existing activities. 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. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Sourcemodule GetExecutionHistoryOutput : sig ... end

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. 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. This API action is not supported by EXPRESS state machines.

Sourcemodule GetExecutionHistoryInput : sig ... end

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. 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. This API action is not supported by EXPRESS state machines.

Sourcemodule GetActivityTaskOutput : sig ... end

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. This API action isn't logged in CloudTrail. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

Sourcemodule GetActivityTaskInput : sig ... end

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. This API action isn't logged in CloudTrail. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

Sourcemodule DescribeStateMachineOutput : sig ... end

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Sourcemodule DescribeStateMachineInput : sig ... end

Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following qualified state machine ARN refers to an alias named PROD. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> This API action returns the details for a state machine version if the stateMachineArn you specify is a state machine version ARN. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Sourcemodule DescribeStateMachineForExecutionOutput : sig ... end

Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.

Sourcemodule DescribeStateMachineForExecutionInput : sig ... end

Provides information about a state machine's definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. This API action is not supported by EXPRESS state machines.

Sourcemodule DescribeStateMachineAliasOutput : sig ... end

Returns details about a state machine alias. Related operations: CreateStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias DeleteStateMachineAlias

Sourcemodule DescribeStateMachineAliasInput : sig ... end

Returns details about a state machine alias. Related operations: CreateStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias DeleteStateMachineAlias

Sourcemodule DescribeMapRunOutput : sig ... end

Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

Sourcemodule DescribeMapRunInput : sig ... end

Provides information about a Map Run's configuration, progress, and results. If you've redriven a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see Examining Map Run in the Step Functions Developer Guide.

Sourcemodule DescribeExecutionOutput : sig ... end

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run. If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. Executions of an EXPRESS state machine aren't supported by DescribeExecution unless a Map Run dispatched them.

Sourcemodule DescribeExecutionInput : sig ... end

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run. If you specify a version or alias ARN when you call the StartExecution API action, DescribeExecution returns that ARN. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. Executions of an EXPRESS state machine aren't supported by DescribeExecution unless a Map Run dispatched them.

Sourcemodule DescribeActivityOutput : sig ... end

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

Sourcemodule DescribeActivityInput : sig ... end

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

Sourcemodule DeleteStateMachineVersionOutput : sig ... end

Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias. Deleting a state machine version won't terminate its in-progress executions. You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version. Related operations: PublishStateMachineVersion ListStateMachineVersions

Sourcemodule DeleteStateMachineVersionInput : sig ... end

Deletes a state machine version. After you delete a version, you can't call StartExecution using that version's ARN or use the version with a state machine alias. Deleting a state machine version won't terminate its in-progress executions. You can't delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version. Related operations: PublishStateMachineVersion ListStateMachineVersions

Sourcemodule DeleteStateMachineOutput : sig ... end

Deletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine This API action also deletes all versions and aliases associated with a state machine. For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called.

Sourcemodule DeleteStateMachineInput : sig ... end

Deletes a state machine. This is an asynchronous operation. It sets the state machine's status to DELETING and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated. A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN. The following are some examples of qualified and unqualified state machine ARNs: The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException. The following unqualified state machine ARN refers to a state machine named myStateMachine. arn:partition:states:region:account-id:stateMachine:myStateMachine This API action also deletes all versions and aliases associated with a state machine. For EXPRESS state machines, the deletion happens eventually (usually in less than a minute). Running executions may emit logs after DeleteStateMachine API is called.

Sourcemodule DeleteStateMachineAliasOutput : sig ... end

Deletes a state machine alias. After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references. Related operations: CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias

Sourcemodule DeleteStateMachineAliasInput : sig ... end

Deletes a state machine alias. After you delete a state machine alias, you can't use it to start executions. When you delete a state machine alias, Step Functions doesn't delete the state machine versions that alias references. Related operations: CreateStateMachineAlias DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias

Sourcemodule DeleteActivityOutput : sig ... end

Deletes an activity.

Sourcemodule DeleteActivityInput : sig ... end

Deletes an activity.

Sourcemodule CreateStateMachineOutput : sig ... end

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide. If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine. For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

Sourcemodule CreateStateMachineInput : sig ... end

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide. If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine. For additional control over security, you can encrypt your data using a customer-managed key for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a State Machine. The execution history and state machine definition will be encrypted with the key applied to the State Machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, TracingConfiguration, and EncryptionConfiguration The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

Sourcemodule CreateStateMachineAliasOutput : sig ... end

Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code. You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify. To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100. You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action. CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource. Related operations: DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias DeleteStateMachineAlias

Sourcemodule CreateStateMachineAliasInput : sig ... end

Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code. You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify. To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100. You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action. CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource. Related operations: DescribeStateMachineAlias ListStateMachineAliases UpdateStateMachineAlias DeleteStateMachineAlias

Sourcemodule CreateActivityOutput : sig ... end

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

Sourcemodule CreateActivityInput : sig ... end

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.