Skip to main content Link Search Menu Expand Document (external link)

SFNService overview

Added in v1.0.0


Table of contents


constructors

makeSFNService

Signature

export declare const makeSFNService: Effect.Effect<any, unknown, unknown>

Added in v1.0.0

models

SFNService (class)

Signature

export declare class SFNService

Added in v1.0.0

SFNService$ (interface)

Signature

export interface SFNService$ {
  /**
   * @see {@link CreateActivityCommand}
   */
  createActivity(
    args: CreateActivityCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateActivityCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ActivityAlreadyExistsError
    | ActivityLimitExceededError
    | InvalidEncryptionConfigurationError
    | InvalidNameError
    | KmsAccessDeniedError
    | KmsThrottlingError
    | TooManyTagsError
  >

  /**
   * @see {@link CreateStateMachineCommand}
   */
  createStateMachine(
    args: CreateStateMachineCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateStateMachineCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InvalidArnError
    | InvalidDefinitionError
    | InvalidEncryptionConfigurationError
    | InvalidLoggingConfigurationError
    | InvalidNameError
    | InvalidTracingConfigurationError
    | KmsAccessDeniedError
    | KmsThrottlingError
    | StateMachineAlreadyExistsError
    | StateMachineDeletingError
    | StateMachineLimitExceededError
    | StateMachineTypeNotSupportedError
    | TooManyTagsError
    | ValidationError
  >

  /**
   * @see {@link CreateStateMachineAliasCommand}
   */
  createStateMachineAlias(
    args: CreateStateMachineAliasCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateStateMachineAliasCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InvalidArnError
    | InvalidNameError
    | ResourceNotFoundError
    | ServiceQuotaExceededError
    | StateMachineDeletingError
    | ValidationError
  >

  /**
   * @see {@link DeleteActivityCommand}
   */
  deleteActivity(
    args: DeleteActivityCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<DeleteActivityCommandOutput, Cause.TimeoutError | SdkError | InvalidArnError>

  /**
   * @see {@link DeleteStateMachineCommand}
   */
  deleteStateMachine(
    args: DeleteStateMachineCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<DeleteStateMachineCommandOutput, Cause.TimeoutError | SdkError | InvalidArnError | ValidationError>

  /**
   * @see {@link DeleteStateMachineAliasCommand}
   */
  deleteStateMachineAlias(
    args: DeleteStateMachineAliasCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteStateMachineAliasCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InvalidArnError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DeleteStateMachineVersionCommand}
   */
  deleteStateMachineVersion(
    args: DeleteStateMachineVersionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteStateMachineVersionCommandOutput,
    Cause.TimeoutError | SdkError | ConflictError | InvalidArnError | ValidationError
  >

  /**
   * @see {@link DescribeActivityCommand}
   */
  describeActivity(
    args: DescribeActivityCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeActivityCommandOutput,
    Cause.TimeoutError | SdkError | ActivityDoesNotExistError | InvalidArnError
  >

  /**
   * @see {@link DescribeExecutionCommand}
   */
  describeExecution(
    args: DescribeExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ExecutionDoesNotExistError
    | InvalidArnError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
  >

  /**
   * @see {@link DescribeMapRunCommand}
   */
  describeMapRun(
    args: DescribeMapRunCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<DescribeMapRunCommandOutput, Cause.TimeoutError | SdkError | InvalidArnError | ResourceNotFoundError>

  /**
   * @see {@link DescribeStateMachineCommand}
   */
  describeStateMachine(
    args: DescribeStateMachineCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeStateMachineCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArnError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
    | StateMachineDoesNotExistError
  >

  /**
   * @see {@link DescribeStateMachineAliasCommand}
   */
  describeStateMachineAlias(
    args: DescribeStateMachineAliasCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeStateMachineAliasCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArnError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link DescribeStateMachineForExecutionCommand}
   */
  describeStateMachineForExecution(
    args: DescribeStateMachineForExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeStateMachineForExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ExecutionDoesNotExistError
    | InvalidArnError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
  >

  /**
   * @see {@link GetActivityTaskCommand}
   */
  getActivityTask(
    args: GetActivityTaskCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetActivityTaskCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ActivityDoesNotExistError
    | ActivityWorkerLimitExceededError
    | InvalidArnError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
  >

  /**
   * @see {@link GetExecutionHistoryCommand}
   */
  getExecutionHistory(
    args: GetExecutionHistoryCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetExecutionHistoryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ExecutionDoesNotExistError
    | InvalidArnError
    | InvalidTokenError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
  >

  getExecutionHistoryStream(
    args: GetExecutionHistoryCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    GetExecutionHistoryCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ExecutionDoesNotExistError
    | InvalidArnError
    | InvalidTokenError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
  >

  /**
   * @see {@link ListActivitiesCommand}
   */
  listActivities(
    args: ListActivitiesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListActivitiesCommandOutput, Cause.TimeoutError | SdkError | InvalidTokenError>

  listActivitiesStream(
    args: ListActivitiesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<ListActivitiesCommandOutput, Cause.TimeoutError | SdkError | InvalidTokenError>

  /**
   * @see {@link ListExecutionsCommand}
   */
  listExecutions(
    args: ListExecutionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListExecutionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArnError
    | InvalidTokenError
    | ResourceNotFoundError
    | StateMachineDoesNotExistError
    | StateMachineTypeNotSupportedError
    | ValidationError
  >

  listExecutionsStream(
    args: ListExecutionsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListExecutionsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArnError
    | InvalidTokenError
    | ResourceNotFoundError
    | StateMachineDoesNotExistError
    | StateMachineTypeNotSupportedError
    | ValidationError
  >

  /**
   * @see {@link ListMapRunsCommand}
   */
  listMapRuns(
    args: ListMapRunsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListMapRunsCommandOutput,
    Cause.TimeoutError | SdkError | ExecutionDoesNotExistError | InvalidArnError | InvalidTokenError
  >

  listMapRunsStream(
    args: ListMapRunsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListMapRunsCommandOutput,
    Cause.TimeoutError | SdkError | ExecutionDoesNotExistError | InvalidArnError | InvalidTokenError
  >

  /**
   * @see {@link ListStateMachineAliasesCommand}
   */
  listStateMachineAliases(
    args: ListStateMachineAliasesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListStateMachineAliasesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArnError
    | InvalidTokenError
    | ResourceNotFoundError
    | StateMachineDeletingError
    | StateMachineDoesNotExistError
  >

  /**
   * @see {@link ListStateMachineVersionsCommand}
   */
  listStateMachineVersions(
    args: ListStateMachineVersionsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListStateMachineVersionsCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArnError | InvalidTokenError | ValidationError
  >

  /**
   * @see {@link ListStateMachinesCommand}
   */
  listStateMachines(
    args: ListStateMachinesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ListStateMachinesCommandOutput, Cause.TimeoutError | SdkError | InvalidTokenError>

  listStateMachinesStream(
    args: ListStateMachinesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<ListStateMachinesCommandOutput, Cause.TimeoutError | SdkError | InvalidTokenError>

  /**
   * @see {@link ListTagsForResourceCommand}
   */
  listTagsForResource(
    args: ListTagsForResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListTagsForResourceCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArnError | ResourceNotFoundError
  >

  /**
   * @see {@link PublishStateMachineVersionCommand}
   */
  publishStateMachineVersion(
    args: PublishStateMachineVersionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PublishStateMachineVersionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InvalidArnError
    | ServiceQuotaExceededError
    | StateMachineDeletingError
    | StateMachineDoesNotExistError
    | ValidationError
  >

  /**
   * @see {@link RedriveExecutionCommand}
   */
  redriveExecution(
    args: RedriveExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RedriveExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ExecutionDoesNotExistError
    | ExecutionLimitExceededError
    | ExecutionNotRedrivableError
    | InvalidArnError
    | ValidationError
  >

  /**
   * @see {@link SendTaskFailureCommand}
   */
  sendTaskFailure(
    args: SendTaskFailureCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    SendTaskFailureCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidTokenError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
    | TaskDoesNotExistError
    | TaskTimedOutError
  >

  /**
   * @see {@link SendTaskHeartbeatCommand}
   */
  sendTaskHeartbeat(
    args: SendTaskHeartbeatCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    SendTaskHeartbeatCommandOutput,
    Cause.TimeoutError | SdkError | InvalidTokenError | TaskDoesNotExistError | TaskTimedOutError
  >

  /**
   * @see {@link SendTaskSuccessCommand}
   */
  sendTaskSuccess(
    args: SendTaskSuccessCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    SendTaskSuccessCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidOutputError
    | InvalidTokenError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
    | TaskDoesNotExistError
    | TaskTimedOutError
  >

  /**
   * @see {@link StartExecutionCommand}
   */
  startExecution(
    args: StartExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ExecutionAlreadyExistsError
    | ExecutionLimitExceededError
    | InvalidArnError
    | InvalidExecutionInputError
    | InvalidNameError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
    | StateMachineDeletingError
    | StateMachineDoesNotExistError
    | ValidationError
  >

  /**
   * @see {@link StartSyncExecutionCommand}
   */
  startSyncExecution(
    args: StartSyncExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StartSyncExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArnError
    | InvalidExecutionInputError
    | InvalidNameError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
    | StateMachineDeletingError
    | StateMachineDoesNotExistError
    | StateMachineTypeNotSupportedError
  >

  /**
   * @see {@link StopExecutionCommand}
   */
  stopExecution(
    args: StopExecutionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    StopExecutionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ExecutionDoesNotExistError
    | InvalidArnError
    | KmsAccessDeniedError
    | KmsInvalidStateError
    | KmsThrottlingError
    | ValidationError
  >

  /**
   * @see {@link TagResourceCommand}
   */
  tagResource(
    args: TagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    TagResourceCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArnError | ResourceNotFoundError | TooManyTagsError
  >

  /**
   * @see {@link TestStateCommand}
   */
  testState(
    args: TestStateCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    TestStateCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArnError
    | InvalidDefinitionError
    | InvalidExecutionInputError
    | ValidationError
  >

  /**
   * @see {@link UntagResourceCommand}
   */
  untagResource(
    args: UntagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<UntagResourceCommandOutput, Cause.TimeoutError | SdkError | InvalidArnError | ResourceNotFoundError>

  /**
   * @see {@link UpdateMapRunCommand}
   */
  updateMapRun(
    args: UpdateMapRunCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateMapRunCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArnError | ResourceNotFoundError | ValidationError
  >

  /**
   * @see {@link UpdateStateMachineCommand}
   */
  updateStateMachine(
    args: UpdateStateMachineCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateStateMachineCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InvalidArnError
    | InvalidDefinitionError
    | InvalidEncryptionConfigurationError
    | InvalidLoggingConfigurationError
    | InvalidTracingConfigurationError
    | KmsAccessDeniedError
    | KmsThrottlingError
    | MissingRequiredParameterError
    | ServiceQuotaExceededError
    | StateMachineDeletingError
    | StateMachineDoesNotExistError
    | ValidationError
  >

  /**
   * @see {@link UpdateStateMachineAliasCommand}
   */
  updateStateMachineAlias(
    args: UpdateStateMachineAliasCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateStateMachineAliasCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | InvalidArnError
    | ResourceNotFoundError
    | StateMachineDeletingError
    | ValidationError
  >

  /**
   * @see {@link ValidateStateMachineDefinitionCommand}
   */
  validateStateMachineDefinition(
    args: ValidateStateMachineDefinitionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<ValidateStateMachineDefinitionCommandOutput, Cause.TimeoutError | SdkError | ValidationError>
}

Added in v1.0.0

utils

SFNService (namespace)

Added in v1.0.0

Config (interface)

Signature

export interface Config extends Omit<SFNClientConfig, "logger"> {
  readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}

Added in v1.0.0

Type (type alias)

Signature

export type Type = SFNService$

Added in v1.0.0