= AWS StepFunctions Component
:doctitle: AWS StepFunctions
:shortname: aws2-step-functions
:artifactid: camel-aws2-step-functions
:description: Manage and invoke AWS Step functions.
:since: 4.0
:supportlevel: Stable
:tabs-sync-option:
:component-header: Only producer is supported
//Manually maintained attributes
:group: AWS
:camel-spring-boot-name: aws2-step-functions

*Since Camel {since}*

*{component-header}*

The AWS2 Step Functions component supports the following operations on
https://aws.amazon.com/step-functions/[AWS Step Functions]:

- Create, delete, update, describe, list state machines.
- Create, delete, describe, list activities.
- Start, start sync, stop, list, describe executions.
- Get activities task.
- Get execution history

Prerequisites

You must have a valid Amazon Web Services developer account, and be
signed up to use Amazon Step Functions. More information is available at
https://aws.amazon.com/step-functions/[AWS Step Functions].


== URI Format

-------------------------
aws2-step-functions://label[?options]
-------------------------

You can append query options to the URI in the following format:

`?options=value&option2=value&...`


// component-configure options: START

// component-configure options: END

// component options: START
include::partial$component-configure-options.adoc[]
include::partial$component-endpoint-options.adoc[]
// component options: END

// endpoint options: START

// endpoint options: END


Required Step Functions component options

You have to provide the awsSfnClient in the
Registry or your accessKey and secretKey to access
the https://aws.amazon.com/step-functions/[AWS Step Functions] service.

// component headers: START
include::partial$component-endpoint-headers.adoc[]
// component headers: END

== Usage

=== Static credentials, Default Credential Provider and Profile Credentials Provider

You have the possibility of avoiding the usage of explicit static credentials by specifying the useDefaultCredentialsProvider option and set it to true.

The order of evaluation for Default Credentials Provider is the following:

 - Java system properties - `aws.accessKeyId` and `aws.secretKey`.
 - Environment variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
 - Web Identity Token from AWS STS.
 - The shared credentials and config files.
 - Amazon ECS container credentials - loaded from the Amazon ECS if the environment variable `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` is set.
 - Amazon EC2 Instance profile credentials.

You have also the possibility of using Profile Credentials Provider, by specifying the useProfileCredentialsProvider option to true and profileCredentialsName to the profile name.

Only one of static, default and profile credentials could be used at the same time.

For more information about this you can look at https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html[AWS credentials documentation]

=== Step Functions Producer operations

Camel-AWS Step Functions component provides the following operation on the producer side:

- createStateMachine
- deleteStateMachine
- updateStateMachine
- describeStateMachine
- listStateMachines
- createActivity
- deleteActivity
- describeActivity
- getActivityTask
- listActivities
- startExecution
- startSyncExecution
- stopExecution
- describeExecution
- listExecutions
- getExecutionHistory

== Examples

=== Producer Examples

- createStateMachine: this operation will create a state machine

[source,java]
--------------------------------------------------------------------------------
from("direct:createStateMachine")
    .to("aws2-step-functions://test?awsSfnClient=#awsSfnClient&operation=createMachine")
--------------------------------------------------------------------------------

=== Using a POJO as body

Sometimes building an AWS Request can be complex because of multiple options. We introduce the possibility to use a POJO as the body.
In AWS Step Functions, there are multiple operations you can submit, as an example for Create state machine
 request, you can do something like:

[source,java]
------------------------------------------------------------------------------------------------------
from("direct:start")
  .setBody(CreateStateMachineRequest.builder().name("state-machine").build())
  .to("aws2-step-functions://test?awsSfnClient=#awsSfnClient&operation=createStateMachine&pojoRequest=true")
------------------------------------------------------------------------------------------------------

In this way, you'll pass the request directly without the need of passing headers and options specifically related to this operation.

== Dependencies

Maven users will need to add the following dependency to their pom.xml.

*pom.xml*

[source,xml]
---------------------------------------
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws2-step-functions</artifactId>
    <version>${camel-version}</version>
</dependency>
---------------------------------------

where `$\{camel-version}` must be replaced by the actual version of Camel.


include::spring-boot:partial$starter.adoc[]
