AWS SDK for C++  1.9.125
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::SFN::SFNClient Class Reference

#include <SFNClient.h>

+ Inheritance diagram for Aws::SFN::SFNClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 SFNClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 SFNClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 SFNClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~SFNClient ()
 
virtual Model::CreateActivityOutcome CreateActivity (const Model::CreateActivityRequest &request) const
 
virtual Model::CreateActivityOutcomeCallable CreateActivityCallable (const Model::CreateActivityRequest &request) const
 
virtual void CreateActivityAsync (const Model::CreateActivityRequest &request, const CreateActivityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateStateMachineOutcome CreateStateMachine (const Model::CreateStateMachineRequest &request) const
 
virtual Model::CreateStateMachineOutcomeCallable CreateStateMachineCallable (const Model::CreateStateMachineRequest &request) const
 
virtual void CreateStateMachineAsync (const Model::CreateStateMachineRequest &request, const CreateStateMachineResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteActivityOutcome DeleteActivity (const Model::DeleteActivityRequest &request) const
 
virtual Model::DeleteActivityOutcomeCallable DeleteActivityCallable (const Model::DeleteActivityRequest &request) const
 
virtual void DeleteActivityAsync (const Model::DeleteActivityRequest &request, const DeleteActivityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteStateMachineOutcome DeleteStateMachine (const Model::DeleteStateMachineRequest &request) const
 
virtual Model::DeleteStateMachineOutcomeCallable DeleteStateMachineCallable (const Model::DeleteStateMachineRequest &request) const
 
virtual void DeleteStateMachineAsync (const Model::DeleteStateMachineRequest &request, const DeleteStateMachineResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeActivityOutcome DescribeActivity (const Model::DescribeActivityRequest &request) const
 
virtual Model::DescribeActivityOutcomeCallable DescribeActivityCallable (const Model::DescribeActivityRequest &request) const
 
virtual void DescribeActivityAsync (const Model::DescribeActivityRequest &request, const DescribeActivityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeExecutionOutcome DescribeExecution (const Model::DescribeExecutionRequest &request) const
 
virtual Model::DescribeExecutionOutcomeCallable DescribeExecutionCallable (const Model::DescribeExecutionRequest &request) const
 
virtual void DescribeExecutionAsync (const Model::DescribeExecutionRequest &request, const DescribeExecutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeStateMachineOutcome DescribeStateMachine (const Model::DescribeStateMachineRequest &request) const
 
virtual Model::DescribeStateMachineOutcomeCallable DescribeStateMachineCallable (const Model::DescribeStateMachineRequest &request) const
 
virtual void DescribeStateMachineAsync (const Model::DescribeStateMachineRequest &request, const DescribeStateMachineResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeStateMachineForExecutionOutcome DescribeStateMachineForExecution (const Model::DescribeStateMachineForExecutionRequest &request) const
 
virtual Model::DescribeStateMachineForExecutionOutcomeCallable DescribeStateMachineForExecutionCallable (const Model::DescribeStateMachineForExecutionRequest &request) const
 
virtual void DescribeStateMachineForExecutionAsync (const Model::DescribeStateMachineForExecutionRequest &request, const DescribeStateMachineForExecutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetActivityTaskOutcome GetActivityTask (const Model::GetActivityTaskRequest &request) const
 
virtual Model::GetActivityTaskOutcomeCallable GetActivityTaskCallable (const Model::GetActivityTaskRequest &request) const
 
virtual void GetActivityTaskAsync (const Model::GetActivityTaskRequest &request, const GetActivityTaskResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetExecutionHistoryOutcome GetExecutionHistory (const Model::GetExecutionHistoryRequest &request) const
 
virtual Model::GetExecutionHistoryOutcomeCallable GetExecutionHistoryCallable (const Model::GetExecutionHistoryRequest &request) const
 
virtual void GetExecutionHistoryAsync (const Model::GetExecutionHistoryRequest &request, const GetExecutionHistoryResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListActivitiesOutcome ListActivities (const Model::ListActivitiesRequest &request) const
 
virtual Model::ListActivitiesOutcomeCallable ListActivitiesCallable (const Model::ListActivitiesRequest &request) const
 
virtual void ListActivitiesAsync (const Model::ListActivitiesRequest &request, const ListActivitiesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListExecutionsOutcome ListExecutions (const Model::ListExecutionsRequest &request) const
 
virtual Model::ListExecutionsOutcomeCallable ListExecutionsCallable (const Model::ListExecutionsRequest &request) const
 
virtual void ListExecutionsAsync (const Model::ListExecutionsRequest &request, const ListExecutionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListStateMachinesOutcome ListStateMachines (const Model::ListStateMachinesRequest &request) const
 
virtual Model::ListStateMachinesOutcomeCallable ListStateMachinesCallable (const Model::ListStateMachinesRequest &request) const
 
virtual void ListStateMachinesAsync (const Model::ListStateMachinesRequest &request, const ListStateMachinesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForResourceOutcome ListTagsForResource (const Model::ListTagsForResourceRequest &request) const
 
virtual Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable (const Model::ListTagsForResourceRequest &request) const
 
virtual void ListTagsForResourceAsync (const Model::ListTagsForResourceRequest &request, const ListTagsForResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SendTaskFailureOutcome SendTaskFailure (const Model::SendTaskFailureRequest &request) const
 
virtual Model::SendTaskFailureOutcomeCallable SendTaskFailureCallable (const Model::SendTaskFailureRequest &request) const
 
virtual void SendTaskFailureAsync (const Model::SendTaskFailureRequest &request, const SendTaskFailureResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SendTaskHeartbeatOutcome SendTaskHeartbeat (const Model::SendTaskHeartbeatRequest &request) const
 
virtual Model::SendTaskHeartbeatOutcomeCallable SendTaskHeartbeatCallable (const Model::SendTaskHeartbeatRequest &request) const
 
virtual void SendTaskHeartbeatAsync (const Model::SendTaskHeartbeatRequest &request, const SendTaskHeartbeatResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::SendTaskSuccessOutcome SendTaskSuccess (const Model::SendTaskSuccessRequest &request) const
 
virtual Model::SendTaskSuccessOutcomeCallable SendTaskSuccessCallable (const Model::SendTaskSuccessRequest &request) const
 
virtual void SendTaskSuccessAsync (const Model::SendTaskSuccessRequest &request, const SendTaskSuccessResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::StartExecutionOutcome StartExecution (const Model::StartExecutionRequest &request) const
 
virtual Model::StartExecutionOutcomeCallable StartExecutionCallable (const Model::StartExecutionRequest &request) const
 
virtual void StartExecutionAsync (const Model::StartExecutionRequest &request, const StartExecutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::StartSyncExecutionOutcome StartSyncExecution (const Model::StartSyncExecutionRequest &request) const
 
virtual Model::StartSyncExecutionOutcomeCallable StartSyncExecutionCallable (const Model::StartSyncExecutionRequest &request) const
 
virtual void StartSyncExecutionAsync (const Model::StartSyncExecutionRequest &request, const StartSyncExecutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::StopExecutionOutcome StopExecution (const Model::StopExecutionRequest &request) const
 
virtual Model::StopExecutionOutcomeCallable StopExecutionCallable (const Model::StopExecutionRequest &request) const
 
virtual void StopExecutionAsync (const Model::StopExecutionRequest &request, const StopExecutionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagResourceOutcome TagResource (const Model::TagResourceRequest &request) const
 
virtual Model::TagResourceOutcomeCallable TagResourceCallable (const Model::TagResourceRequest &request) const
 
virtual void TagResourceAsync (const Model::TagResourceRequest &request, const TagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagResourceOutcome UntagResource (const Model::UntagResourceRequest &request) const
 
virtual Model::UntagResourceOutcomeCallable UntagResourceCallable (const Model::UntagResourceRequest &request) const
 
virtual void UntagResourceAsync (const Model::UntagResourceRequest &request, const UntagResourceResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateStateMachineOutcome UpdateStateMachine (const Model::UpdateStateMachineRequest &request) const
 
virtual Model::UpdateStateMachineOutcomeCallable UpdateStateMachineCallable (const Model::UpdateStateMachineRequest &request) const
 
virtual void UpdateStateMachineAsync (const Model::UpdateStateMachineRequest &request, const UpdateStateMachineResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const char *signerName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

<fullname>AWS Step Functions</fullname>

AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.

You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.

Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .

Definition at line 194 of file SFNClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 197 of file SFNClient.h.

Constructor & Destructor Documentation

◆ SFNClient() [1/3]

Aws::SFN::SFNClient::SFNClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ SFNClient() [2/3]

Aws::SFN::SFNClient::SFNClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ SFNClient() [3/3]

Aws::SFN::SFNClient::SFNClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~SFNClient()

virtual Aws::SFN::SFNClient::~SFNClient ( )
virtual

Member Function Documentation

◆ CreateActivity()

virtual Model::CreateActivityOutcome Aws::SFN::SFNClient::CreateActivity ( const Model::CreateActivityRequest request) const
virtual

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS 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.

See Also:

AWS API Reference

◆ CreateActivityAsync()

virtual void Aws::SFN::SFNClient::CreateActivityAsync ( const Model::CreateActivityRequest request,
const CreateActivityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateActivityCallable()

virtual Model::CreateActivityOutcomeCallable Aws::SFN::SFNClient::CreateActivityCallable ( const Model::CreateActivityRequest request) const
virtual

Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateStateMachine()

virtual Model::CreateStateMachineOutcome Aws::SFN::SFNClient::CreateStateMachine ( const Model::CreateStateMachineRequest request) const
virtual

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 AWS Step Functions User Guide.

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 and TracingConfiguration. 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.

See Also:

AWS API Reference

◆ CreateStateMachineAsync()

virtual void Aws::SFN::SFNClient::CreateStateMachineAsync ( const Model::CreateStateMachineRequest request,
const CreateStateMachineResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 AWS Step Functions User Guide.

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 and TracingConfiguration. 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateStateMachineCallable()

virtual Model::CreateStateMachineOutcomeCallable Aws::SFN::SFNClient::CreateStateMachineCallable ( const Model::CreateStateMachineRequest request) const
virtual

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 AWS Step Functions User Guide.

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 and TracingConfiguration. 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteActivity()

virtual Model::DeleteActivityOutcome Aws::SFN::SFNClient::DeleteActivity ( const Model::DeleteActivityRequest request) const
virtual

Deletes an activity.

See Also:

AWS API Reference

◆ DeleteActivityAsync()

virtual void Aws::SFN::SFNClient::DeleteActivityAsync ( const Model::DeleteActivityRequest request,
const DeleteActivityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes an activity.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteActivityCallable()

virtual Model::DeleteActivityOutcomeCallable Aws::SFN::SFNClient::DeleteActivityCallable ( const Model::DeleteActivityRequest request) const
virtual

Deletes an activity.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteStateMachine()

virtual Model::DeleteStateMachineOutcome Aws::SFN::SFNClient::DeleteStateMachine ( const Model::DeleteStateMachineRequest request) const
virtual

Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.

For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.

See Also:

AWS API Reference

◆ DeleteStateMachineAsync()

virtual void Aws::SFN::SFNClient::DeleteStateMachineAsync ( const Model::DeleteStateMachineRequest request,
const DeleteStateMachineResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.

For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteStateMachineCallable()

virtual Model::DeleteStateMachineOutcomeCallable Aws::SFN::SFNClient::DeleteStateMachineCallable ( const Model::DeleteStateMachineRequest request) const
virtual

Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process.

For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeActivity()

virtual Model::DescribeActivityOutcome Aws::SFN::SFNClient::DescribeActivity ( const Model::DescribeActivityRequest request) const
virtual

Describes an activity.

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

See Also:

AWS API Reference

◆ DescribeActivityAsync()

virtual void Aws::SFN::SFNClient::DescribeActivityAsync ( const Model::DescribeActivityRequest request,
const DescribeActivityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes an activity.

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeActivityCallable()

virtual Model::DescribeActivityOutcomeCallable Aws::SFN::SFNClient::DescribeActivityCallable ( const Model::DescribeActivityRequest request) const
virtual

Describes an activity.

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeExecution()

virtual Model::DescribeExecutionOutcome Aws::SFN::SFNClient::DescribeExecution ( const Model::DescribeExecutionRequest request) const
virtual

Describes an execution.

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.

See Also:

AWS API Reference

◆ DescribeExecutionAsync()

virtual void Aws::SFN::SFNClient::DescribeExecutionAsync ( const Model::DescribeExecutionRequest request,
const DescribeExecutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes an execution.

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeExecutionCallable()

virtual Model::DescribeExecutionOutcomeCallable Aws::SFN::SFNClient::DescribeExecutionCallable ( const Model::DescribeExecutionRequest request) const
virtual

Describes an execution.

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeStateMachine()

virtual Model::DescribeStateMachineOutcome Aws::SFN::SFNClient::DescribeStateMachine ( const Model::DescribeStateMachineRequest request) const
virtual

Describes a state machine.

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

See Also:

AWS API Reference

◆ DescribeStateMachineAsync()

virtual void Aws::SFN::SFNClient::DescribeStateMachineAsync ( const Model::DescribeStateMachineRequest request,
const DescribeStateMachineResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes a state machine.

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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeStateMachineCallable()

virtual Model::DescribeStateMachineOutcomeCallable Aws::SFN::SFNClient::DescribeStateMachineCallable ( const Model::DescribeStateMachineRequest request) const
virtual

Describes a state machine.

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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeStateMachineForExecution()

virtual Model::DescribeStateMachineForExecutionOutcome Aws::SFN::SFNClient::DescribeStateMachineForExecution ( const Model::DescribeStateMachineForExecutionRequest request) const
virtual

Describes the state machine associated with a specific execution.

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.

See Also:


AWS API Reference

◆ DescribeStateMachineForExecutionAsync()

virtual void Aws::SFN::SFNClient::DescribeStateMachineForExecutionAsync ( const Model::DescribeStateMachineForExecutionRequest request,
const DescribeStateMachineForExecutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Describes the state machine associated with a specific execution.

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.

See Also:


AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeStateMachineForExecutionCallable()

virtual Model::DescribeStateMachineForExecutionOutcomeCallable Aws::SFN::SFNClient::DescribeStateMachineForExecutionCallable ( const Model::DescribeStateMachineForExecutionRequest request) const
virtual

Describes the state machine associated with a specific execution.

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.

See Also:


AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetActivityTask()

virtual Model::GetActivityTaskOutcome Aws::SFN::SFNClient::GetActivityTask ( const Model::GetActivityTaskRequest request) const
virtual

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.

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.

See Also:

AWS API Reference

◆ GetActivityTaskAsync()

virtual void Aws::SFN::SFNClient::GetActivityTaskAsync ( const Model::GetActivityTaskRequest request,
const GetActivityTaskResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetActivityTaskCallable()

virtual Model::GetActivityTaskOutcomeCallable Aws::SFN::SFNClient::GetActivityTaskCallable ( const Model::GetActivityTaskRequest request) const
virtual

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.

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetExecutionHistory()

virtual Model::GetExecutionHistoryOutcome Aws::SFN::SFNClient::GetExecutionHistory ( const Model::GetExecutionHistoryRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetExecutionHistoryAsync()

virtual void Aws::SFN::SFNClient::GetExecutionHistoryAsync ( const Model::GetExecutionHistoryRequest request,
const GetExecutionHistoryResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetExecutionHistoryCallable()

virtual Model::GetExecutionHistoryOutcomeCallable Aws::SFN::SFNClient::GetExecutionHistoryCallable ( const Model::GetExecutionHistoryRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListActivities()

virtual Model::ListActivitiesOutcome Aws::SFN::SFNClient::ListActivities ( const Model::ListActivitiesRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ ListActivitiesAsync()

virtual void Aws::SFN::SFNClient::ListActivitiesAsync ( const Model::ListActivitiesRequest request,
const ListActivitiesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListActivitiesCallable()

virtual Model::ListActivitiesOutcomeCallable Aws::SFN::SFNClient::ListActivitiesCallable ( const Model::ListActivitiesRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListExecutions()

virtual Model::ListExecutionsOutcome Aws::SFN::SFNClient::ListExecutions ( const Model::ListExecutionsRequest request) const
virtual

Lists the executions of a state machine that meet the filtering criteria. 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.

See Also:

AWS API Reference

◆ ListExecutionsAsync()

virtual void Aws::SFN::SFNClient::ListExecutionsAsync ( const Model::ListExecutionsRequest request,
const ListExecutionsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the executions of a state machine that meet the filtering criteria. 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListExecutionsCallable()

virtual Model::ListExecutionsOutcomeCallable Aws::SFN::SFNClient::ListExecutionsCallable ( const Model::ListExecutionsRequest request) const
virtual

Lists the executions of a state machine that meet the filtering criteria. 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListStateMachines()

virtual Model::ListStateMachinesOutcome Aws::SFN::SFNClient::ListStateMachines ( const Model::ListStateMachinesRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ ListStateMachinesAsync()

virtual void Aws::SFN::SFNClient::ListStateMachinesAsync ( const Model::ListStateMachinesRequest request,
const ListStateMachinesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListStateMachinesCallable()

virtual Model::ListStateMachinesOutcomeCallable Aws::SFN::SFNClient::ListStateMachinesCallable ( const Model::ListStateMachinesRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTagsForResource()

virtual Model::ListTagsForResourceOutcome Aws::SFN::SFNClient::ListTagsForResource ( const Model::ListTagsForResourceRequest request) const
virtual

List tags for a given resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - </code>.

See Also:

AWS API Reference

◆ ListTagsForResourceAsync()

virtual void Aws::SFN::SFNClient::ListTagsForResourceAsync ( const Model::ListTagsForResourceRequest request,
const ListTagsForResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

List tags for a given resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - </code>.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsForResourceCallable()

virtual Model::ListTagsForResourceOutcomeCallable Aws::SFN::SFNClient::ListTagsForResourceCallable ( const Model::ListTagsForResourceRequest request) const
virtual

List tags for a given resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - </code>.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::SFN::SFNClient::OverrideEndpoint ( const Aws::String endpoint)

◆ SendTaskFailure()

virtual Model::SendTaskFailureOutcome Aws::SFN::SFNClient::SendTaskFailure ( const Model::SendTaskFailureRequest request) const
virtual

Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.

See Also:

AWS API Reference

◆ SendTaskFailureAsync()

virtual void Aws::SFN::SFNClient::SendTaskFailureAsync ( const Model::SendTaskFailureRequest request,
const SendTaskFailureResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ SendTaskFailureCallable()

virtual Model::SendTaskFailureOutcomeCallable Aws::SFN::SFNClient::SendTaskFailureCallable ( const Model::SendTaskFailureRequest request) const
virtual

Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ SendTaskHeartbeat()

virtual Model::SendTaskHeartbeatOutcome Aws::SFN::SFNClient::SendTaskHeartbeat ( const Model::SendTaskHeartbeatRequest request) const
virtual

Used by activity workers and task states using the callback 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 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.

See Also:

AWS API Reference

◆ SendTaskHeartbeatAsync()

virtual void Aws::SFN::SFNClient::SendTaskHeartbeatAsync ( const Model::SendTaskHeartbeatRequest request,
const SendTaskHeartbeatResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Used by activity workers and task states using the callback 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 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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ SendTaskHeartbeatCallable()

virtual Model::SendTaskHeartbeatOutcomeCallable Aws::SFN::SFNClient::SendTaskHeartbeatCallable ( const Model::SendTaskHeartbeatRequest request) const
virtual

Used by activity workers and task states using the callback 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 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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ SendTaskSuccess()

virtual Model::SendTaskSuccessOutcome Aws::SFN::SFNClient::SendTaskSuccess ( const Model::SendTaskSuccessRequest request) const
virtual

Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.

See Also:

AWS API Reference

◆ SendTaskSuccessAsync()

virtual void Aws::SFN::SFNClient::SendTaskSuccessAsync ( const Model::SendTaskSuccessRequest request,
const SendTaskSuccessResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ SendTaskSuccessCallable()

virtual Model::SendTaskSuccessOutcomeCallable Aws::SFN::SFNClient::SendTaskSuccessCallable ( const Model::SendTaskSuccessRequest request) const
virtual

Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ StartExecution()

virtual Model::StartExecutionOutcome Aws::SFN::SFNClient::StartExecution ( const Model::StartExecutionRequest request) const
virtual

Starts a state machine execution.

StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

See Also:

AWS API Reference

◆ StartExecutionAsync()

virtual void Aws::SFN::SFNClient::StartExecutionAsync ( const Model::StartExecutionRequest request,
const StartExecutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Starts a state machine execution.

StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ StartExecutionCallable()

virtual Model::StartExecutionOutcomeCallable Aws::SFN::SFNClient::StartExecutionCallable ( const Model::StartExecutionRequest request) const
virtual

Starts a state machine execution.

StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ StartSyncExecution()

virtual Model::StartSyncExecutionOutcome Aws::SFN::SFNClient::StartSyncExecution ( const Model::StartSyncExecutionRequest request) const
virtual

Starts a Synchronous Express state machine execution.

See Also:

AWS API Reference

◆ StartSyncExecutionAsync()

virtual void Aws::SFN::SFNClient::StartSyncExecutionAsync ( const Model::StartSyncExecutionRequest request,
const StartSyncExecutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Starts a Synchronous Express state machine execution.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ StartSyncExecutionCallable()

virtual Model::StartSyncExecutionOutcomeCallable Aws::SFN::SFNClient::StartSyncExecutionCallable ( const Model::StartSyncExecutionRequest request) const
virtual

Starts a Synchronous Express state machine execution.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ StopExecution()

virtual Model::StopExecutionOutcome Aws::SFN::SFNClient::StopExecution ( const Model::StopExecutionRequest request) const
virtual

Stops an execution.

This API action is not supported by EXPRESS state machines.

See Also:

AWS API Reference

◆ StopExecutionAsync()

virtual void Aws::SFN::SFNClient::StopExecutionAsync ( const Model::StopExecutionRequest request,
const StopExecutionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Stops an execution.

This API action is not supported by EXPRESS state machines.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ StopExecutionCallable()

virtual Model::StopExecutionOutcomeCallable Aws::SFN::SFNClient::StopExecutionCallable ( const Model::StopExecutionRequest request) const
virtual

Stops an execution.

This API action is not supported by EXPRESS state machines.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TagResource()

virtual Model::TagResourceOutcome Aws::SFN::SFNClient::TagResource ( const Model::TagResourceRequest request) const
virtual

Add a tag to a Step Functions resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - </code>.

See Also:

AWS API Reference

◆ TagResourceAsync()

virtual void Aws::SFN::SFNClient::TagResourceAsync ( const Model::TagResourceRequest request,
const TagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Add a tag to a Step Functions resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - </code>.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagResourceCallable()

virtual Model::TagResourceOutcomeCallable Aws::SFN::SFNClient::TagResourceCallable ( const Model::TagResourceRequest request) const
virtual

Add a tag to a Step Functions resource.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - </code>.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagResource()

virtual Model::UntagResourceOutcome Aws::SFN::SFNClient::UntagResource ( const Model::UntagResourceRequest request) const
virtual

Remove a tag from a Step Functions resource

See Also:

AWS API Reference

◆ UntagResourceAsync()

virtual void Aws::SFN::SFNClient::UntagResourceAsync ( const Model::UntagResourceRequest request,
const UntagResourceResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Remove a tag from a Step Functions resource

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagResourceCallable()

virtual Model::UntagResourceOutcomeCallable Aws::SFN::SFNClient::UntagResourceCallable ( const Model::UntagResourceRequest request) const
virtual

Remove a tag from a Step Functions resource

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateStateMachine()

virtual Model::UpdateStateMachineOutcome Aws::SFN::SFNClient::UpdateStateMachine ( const Model::UpdateStateMachineRequest request) const
virtual

Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. 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.

All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.

See Also:

AWS API Reference

◆ UpdateStateMachineAsync()

virtual void Aws::SFN::SFNClient::UpdateStateMachineAsync ( const Model::UpdateStateMachineRequest request,
const UpdateStateMachineResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. 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.

All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateStateMachineCallable()

virtual Model::UpdateStateMachineOutcomeCallable Aws::SFN::SFNClient::UpdateStateMachineCallable ( const Model::UpdateStateMachineRequest request) const
virtual

Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. 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.

All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


The documentation for this class was generated from the following file: