Overviewerlang logo

Module erlcloud_states

Function Index

configure/2
configure/3
configure/4
configure/5
create_activity/1 Create Activity API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateActivity.html
create_activity/2
create_state_machine/3 Create State Machine API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateStateMachine.html
create_state_machine/4
delete_activity/1 Delete Activity API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DeleteActivity.html
delete_activity/2
delete_state_machine/1 Delete State Machine API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DeleteStateMachine.html
delete_state_machine/2
describe_activity/1 Describe Activity API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeActivity.html
describe_activity/2
describe_execution/1 Describe Execution API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeExecution.html
describe_execution/2
describe_state_machine/1 Describe State Machine API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeStateMachine.html
describe_state_machine/2
describe_state_machine_for_execution/1 Describe State Machine For Execution API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeStateMachineForExecution.html
describe_state_machine_for_execution/2
get_activity_task/1 Get a task for particular activity API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_GetActivityTask.html Options map may be provided with optional parameters by key: <<"workerName">>

Example

------------------------------------------------------------------------------.
get_activity_task/2
get_activity_task/3
get_execution_history/1 Get Execution History API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_GetExecutionHistory.html Options map may be provided with optional parameters by key: <<"maxResults">> <<"nextToken">> <<"reverseOrder">>

Example

------------------------------------------------------------------------------.
get_execution_history/2
get_execution_history/3
list_activities/0 List Activities API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_ListActivities.html Options map may be provided with optional parameters by key: <<"maxResults">> <<"nextToken">>

Example

------------------------------------------------------------------------------.
list_activities/1
list_activities/2
list_executions/1 List Executions API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_ListExecutions.html Options map may be provided with optional parameters by key: <<"maxResults">> <<"nextToken">> <<"statusFilter">>

Example

------------------------------------------------------------------------------.
list_executions/2
list_executions/3
list_state_machines/0 List State Machines API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_ListStateMachines.html Options map may be provided with optional parameters by key: <<"maxResults">> <<"nextToken">>

Example

------------------------------------------------------------------------------.
list_state_machines/1
list_state_machines/2
new/2
new/3
new/4
new/5
send_task_failure/1 Sends Task Failure API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskFailure.html Options map may be provided with optional parameters by key: <<"cause">> <<"error">>

Example

------------------------------------------------------------------------------.
send_task_failure/2
send_task_failure/3
send_task_heartbeat/1 Sends Task Heartbeat API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskHeartbeat.html

Example

------------------------------------------------------------------------------.
send_task_heartbeat/2
send_task_success/2 Sends Task Success API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskSuccess.html

Example

------------------------------------------------------------------------------.
send_task_success/3
start_execution/1 Starts Execution API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html Options map may be provided with optional parameters by key: <<"name">> <<"input">> key may be specified but MUST be presented in request

Example

------------------------------------------------------------------------------.
start_execution/2
start_execution/3
stop_execution/1 Stop Execution API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StopExecution.html Options map may be provided with optional parameters by key: <<"cause">> <<"error">>

Example

------------------------------------------------------------------------------.
stop_execution/2
stop_execution/3
update_state_machine/1 Update State Machine API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_UpdateStateMachine.html Options map may be provided with optional parameters by key: <<"definition">> <<"roleArn">>

Example

------------------------------------------------------------------------------.
update_state_machine/2
update_state_machine/3

Function Details

configure/2

configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok

configure/3

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> ok

configure/4

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> ok

configure/5

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer(), Scheme::string()) -> ok

create_activity/1

create_activity(ActivityName::binary()) -> {ok, map()} | {error, any()}

Create Activity API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateActivity.html

Example

------------------------------------------------------------------------------

create_activity/2

create_activity(ActivityName::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

create_state_machine/3

create_state_machine(Definition::map(), StateMachineName::binary(), RoleArn::binary()) -> {ok, map()} | {error, any()}

Create State Machine API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateStateMachine.html

Example

------------------------------------------------------------------------------

create_state_machine/4

create_state_machine(Definition::map(), StateMachineName::binary(), RoleArn::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

delete_activity/1

delete_activity(ActivityArn::binary()) -> ok | {error, any()}

Delete Activity API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DeleteActivity.html

Example

------------------------------------------------------------------------------

delete_activity/2

delete_activity(ActivityArn::binary(), Config::aws_config()) -> ok | {error, any()}

delete_state_machine/1

delete_state_machine(StateMachineArn::binary()) -> ok | {error, any()}

Delete State Machine API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DeleteStateMachine.html

Example

------------------------------------------------------------------------------

delete_state_machine/2

delete_state_machine(StateMachineArn::binary(), Config::aws_config()) -> ok | {error, any()}

describe_activity/1

describe_activity(ActivityArn::binary()) -> {ok, map()} | {error, any()}

Describe Activity API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeActivity.html

Example

------------------------------------------------------------------------------

describe_activity/2

describe_activity(ActivityArn::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

describe_execution/1

describe_execution(ExecutionArn::binary()) -> {ok, map()} | {error, any()}

Describe Execution API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeExecution.html

Example

------------------------------------------------------------------------------

describe_execution/2

describe_execution(ExecutionArn::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

describe_state_machine/1

describe_state_machine(StateMachineArn::binary()) -> {ok, map()} | {error, any()}

Describe State Machine API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeStateMachine.html

Example

------------------------------------------------------------------------------

describe_state_machine/2

describe_state_machine(StateMachineArn::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

describe_state_machine_for_execution/1

describe_state_machine_for_execution(ExecutionArn::binary()) -> {ok, map()} | {error, any()}

Describe State Machine For Execution API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_DescribeStateMachineForExecution.html

Example

------------------------------------------------------------------------------

describe_state_machine_for_execution/2

describe_state_machine_for_execution(ExecutionArn::binary(), Config::aws_config()) -> {ok, map()} | {error, any()}

get_activity_task/1

get_activity_task(ActivityArn::binary()) -> {ok, map()} | {error, any()}

Get a task for particular activity API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_GetActivityTask.html Options map may be provided with optional parameters by key: <<"workerName">>

Example

------------------------------------------------------------------------------

get_activity_task/2

get_activity_task(ActivityArn::binary(), Options::map()) -> {ok, map()} | {error, any()}

get_activity_task/3

get_activity_task(ActivityArn::binary(), Options::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

get_execution_history/1

get_execution_history(ExecutionArn::binary()) -> {ok, map()} | {error, any()}

Get Execution History API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_GetExecutionHistory.html Options map may be provided with optional parameters by key: <<"maxResults">> <<"nextToken">> <<"reverseOrder">>

Example

------------------------------------------------------------------------------

get_execution_history/2

get_execution_history(ExecutionArn::binary(), Options::map()) -> {ok, map()} | {error, any()}

get_execution_history/3

get_execution_history(ExecutionArn::binary(), Options::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

list_activities/0

list_activities() -> {ok, map()} | {error, any()}

List Activities API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_ListActivities.html Options map may be provided with optional parameters by key: <<"maxResults">> <<"nextToken">>

Example

------------------------------------------------------------------------------

list_activities/1

list_activities(Options::map()) -> {ok, map()} | {error, any()}

list_activities/2

list_activities(Options::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

list_executions/1

list_executions(StateMachineArn::binary()) -> {ok, map()} | {error, any()}

List Executions API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_ListExecutions.html Options map may be provided with optional parameters by key: <<"maxResults">> <<"nextToken">> <<"statusFilter">>

Example

------------------------------------------------------------------------------

list_executions/2

list_executions(StateMachineArn::binary(), Options::map()) -> {ok, map()} | {error, any()}

list_executions/3

list_executions(StateMachineArn::binary(), Options::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

list_state_machines/0

list_state_machines() -> {ok, map()} | {error, any()}

List State Machines API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_ListStateMachines.html Options map may be provided with optional parameters by key: <<"maxResults">> <<"nextToken">>

Example

------------------------------------------------------------------------------

list_state_machines/1

list_state_machines(Options::map()) -> {ok, map()} | {error, any()}

list_state_machines/2

list_state_machines(Options::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

new/2

new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()

new/3

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()

new/4

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> aws_config()

new/5

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer(), Scheme::string()) -> aws_config()

send_task_failure/1

send_task_failure(TaskToken::binary()) -> ok | {error, any()}

Sends Task Failure API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskFailure.html Options map may be provided with optional parameters by key: <<"cause">> <<"error">>

Example

------------------------------------------------------------------------------

send_task_failure/2

send_task_failure(TaskToken::binary(), Options::map()) -> ok | {error, any()}

send_task_failure/3

send_task_failure(TaskToken::binary(), Options::map(), Config::aws_config()) -> ok | {error, any()}

send_task_heartbeat/1

send_task_heartbeat(TaskToken::binary()) -> ok | {error, any()}

Sends Task Heartbeat API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskHeartbeat.html

Example

------------------------------------------------------------------------------

send_task_heartbeat/2

send_task_heartbeat(TaskToken::binary(), Config::aws_config()) -> ok | {error, any()}

send_task_success/2

send_task_success(Output::map(), TaskToken::binary()) -> ok | {error, any()}

Sends Task Success API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_SendTaskSuccess.html

Example

------------------------------------------------------------------------------

send_task_success/3

send_task_success(Output::map(), TaskToken::binary(), Config::aws_config()) -> ok | {error, any()}

start_execution/1

start_execution(StateMachineArn::binary()) -> {ok, map()} | {error, any()}

Starts Execution API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html Options map may be provided with optional parameters by key: <<"name">> <<"input">> key may be specified but MUST be presented in request

Example

------------------------------------------------------------------------------

start_execution/2

start_execution(StateMachineArn::binary(), Options::map()) -> {ok, map()} | {error, any()}

start_execution/3

start_execution(StateMachineArn::binary(), Options::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

stop_execution/1

stop_execution(ExecutionArn::binary()) -> {ok, map()} | {error, any()}

Stop Execution API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StopExecution.html Options map may be provided with optional parameters by key: <<"cause">> <<"error">>

Example

------------------------------------------------------------------------------

stop_execution/2

stop_execution(ExecutionArn::binary(), Options::map()) -> {ok, map()} | {error, any()}

stop_execution/3

stop_execution(ExecutionArn::binary(), Options::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

update_state_machine/1

update_state_machine(StateMachineArn::binary()) -> {ok, map()} | {error, any()}

Update State Machine API: https://docs.aws.amazon.com/step-functions/latest/apireference/API_UpdateStateMachine.html Options map may be provided with optional parameters by key: <<"definition">> <<"roleArn">>

Example

------------------------------------------------------------------------------

update_state_machine/2

update_state_machine(StateMachineArn::binary(), Options::map()) -> {ok, map()} | {error, any()}

update_state_machine/3

update_state_machine(StateMachineArn::binary(), Options::map(), Config::aws_config()) -> {ok, map()} | {error, any()}

Overviewerlang logo

Generated by EDoc