da-sfn-client
API
Generated with
da-sfn-client/uk.gov.nationalarchives/DASFNClient

DASFNClient

uk.gov.nationalarchives.DASFNClient
See theDASFNClient companion object
class DASFNClient[F[_]](sfnAsyncClient: SfnAsyncClient)(implicit evidence$1: Async[F])

An SFN client. It is written generically so can be used for any effect which has an Async instance. Requires an implicit instance of cats Async which is used to convert CompletableFuture to F

Type parameters

F

Type of the effect

Value parameters

sfnAsyncClient

An AWS SFN Async client

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def startExecution[T <: Product](stateMachineArn: String, input: T, name: Option[String])(using enc: Encoder[T]): F[StartExecutionResponse]

Type parameters

T

The type of the input case class

Value parameters

enc

A circe encoder which will encode the case class to JSON

input

A case class. This will be deserialised to a json string and sent as input to the step function.

name

An optional step function name. If this is omitted, AWS will generate a UUID for a name.

stateMachineArn

The arn of the state machine to start

Attributes

Returns

The response from the startExecution call, wrapped in F[_]

Generated with