/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the states-2016-11-23.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Net;
using Amazon.StepFunctions.Model;
using Amazon.StepFunctions.Model.Internal.MarshallTransformations;
using Amazon.StepFunctions.Internal;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
using Amazon.Runtime.Internal.Auth;
using Amazon.Runtime.Internal.Transform;
namespace Amazon.StepFunctions
{
///
/// Implementation for accessing StepFunctions
///
/// Step Functions
///
/// 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 Amazon Web Services, your own servers,
/// or any system that has access to Amazon Web Services. You can access and use Step
/// Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more
/// information about Step Functions, see the Step
/// Functions Developer Guide .
///
///
public partial class AmazonStepFunctionsClient : AmazonServiceClient, IAmazonStepFunctions
{
private static IServiceMetadata serviceMetadata = new AmazonStepFunctionsMetadata();
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
private IStepFunctionsPaginatorFactory _paginators;
///
/// Paginators for the service
///
public IStepFunctionsPaginatorFactory Paginators
{
get
{
if (this._paginators == null)
{
this._paginators = new StepFunctionsPaginatorFactory(this);
}
return this._paginators;
}
}
#endif
#region Constructors
///
/// Constructs AmazonStepFunctionsClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
public AmazonStepFunctionsClient()
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonStepFunctionsConfig()) { }
///
/// Constructs AmazonStepFunctionsClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The region to connect.
public AmazonStepFunctionsClient(RegionEndpoint region)
: base(FallbackCredentialsFactory.GetCredentials(), new AmazonStepFunctionsConfig{RegionEndpoint = region}) { }
///
/// Constructs AmazonStepFunctionsClient with the credentials loaded from the application's
/// default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
///
/// Example App.config with credentials set.
///
/// <?xml version="1.0" encoding="utf-8" ?>
/// <configuration>
/// <appSettings>
/// <add key="AWSProfileName" value="AWS Default"/>
/// </appSettings>
/// </configuration>
///
///
///
/// The AmazonStepFunctionsClient Configuration Object
public AmazonStepFunctionsClient(AmazonStepFunctionsConfig config)
: base(FallbackCredentialsFactory.GetCredentials(config), config){}
///
/// Constructs AmazonStepFunctionsClient with AWS Credentials
///
/// AWS Credentials
public AmazonStepFunctionsClient(AWSCredentials credentials)
: this(credentials, new AmazonStepFunctionsConfig())
{
}
///
/// Constructs AmazonStepFunctionsClient with AWS Credentials
///
/// AWS Credentials
/// The region to connect.
public AmazonStepFunctionsClient(AWSCredentials credentials, RegionEndpoint region)
: this(credentials, new AmazonStepFunctionsConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonStepFunctionsClient with AWS Credentials and an
/// AmazonStepFunctionsClient Configuration object.
///
/// AWS Credentials
/// The AmazonStepFunctionsClient Configuration Object
public AmazonStepFunctionsClient(AWSCredentials credentials, AmazonStepFunctionsConfig clientConfig)
: base(credentials, clientConfig)
{
}
///
/// Constructs AmazonStepFunctionsClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
public AmazonStepFunctionsClient(string awsAccessKeyId, string awsSecretAccessKey)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonStepFunctionsConfig())
{
}
///
/// Constructs AmazonStepFunctionsClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The region to connect.
public AmazonStepFunctionsClient(string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, new AmazonStepFunctionsConfig() {RegionEndpoint=region})
{
}
///
/// Constructs AmazonStepFunctionsClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonStepFunctionsClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// The AmazonStepFunctionsClient Configuration Object
public AmazonStepFunctionsClient(string awsAccessKeyId, string awsSecretAccessKey, AmazonStepFunctionsConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, clientConfig)
{
}
///
/// Constructs AmazonStepFunctionsClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
public AmazonStepFunctionsClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonStepFunctionsConfig())
{
}
///
/// Constructs AmazonStepFunctionsClient with AWS Access Key ID and AWS Secret Key
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The region to connect.
public AmazonStepFunctionsClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
: this(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, new AmazonStepFunctionsConfig{RegionEndpoint = region})
{
}
///
/// Constructs AmazonStepFunctionsClient with AWS Access Key ID, AWS Secret Key and an
/// AmazonStepFunctionsClient Configuration object.
///
/// AWS Access Key ID
/// AWS Secret Access Key
/// AWS Session Token
/// The AmazonStepFunctionsClient Configuration Object
public AmazonStepFunctionsClient(string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonStepFunctionsConfig clientConfig)
: base(awsAccessKeyId, awsSecretAccessKey, awsSessionToken, clientConfig)
{
}
#endregion
#region Overrides
///
/// Creates the signer for the service.
///
protected override AbstractAWSSigner CreateSigner()
{
return new AWS4Signer();
}
///
/// Customize the pipeline
///
///
protected override void CustomizeRuntimePipeline(RuntimePipeline pipeline)
{
pipeline.RemoveHandler();
pipeline.AddHandlerAfter(new AmazonStepFunctionsEndpointResolver());
}
///
/// Capture metadata for the service.
///
protected override IServiceMetadata ServiceMetadata
{
get
{
return serviceMetadata;
}
}
#endregion
#region Dispose
///
/// Disposes the service client.
///
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
}
#endregion
#region CreateActivity
///
/// Creates an activity. An activity is a task that you write in any programming language
/// and host on any machine that has access to 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.
///
///
///
/// Container for the necessary parameters to execute the CreateActivity service method.
///
/// The response from the CreateActivity service method, as returned by StepFunctions.
///
/// The maximum number of activities has been reached. Existing activities must be deleted
/// before a new activity can be created.
///
///
/// The provided name is not valid.
///
///
/// You've exceeded the number of tags allowed for a resource. See the
/// Limits Topic in the Step Functions Developer Guide.
///
/// REST API Reference for CreateActivity Operation
public virtual CreateActivityResponse CreateActivity(CreateActivityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateActivityRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateActivityResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the CreateActivity operation.
///
///
/// Container for the necessary parameters to execute the CreateActivity operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateActivity
/// operation.
/// REST API Reference for CreateActivity Operation
public virtual IAsyncResult BeginCreateActivity(CreateActivityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateActivityRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateActivityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the CreateActivity operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateActivity.
///
/// Returns a CreateActivityResult from StepFunctions.
/// REST API Reference for CreateActivity Operation
public virtual CreateActivityResponse EndCreateActivity(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region CreateStateMachine
///
/// 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 Step Functions User Guide.
///
///
///
/// If you set the publish
parameter of this API action to true
,
/// it publishes version 1
as the first revision of the state machine.
///
///
///
/// 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
.
/// The check is also based on the publish
and versionDescription
/// parameters. 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.
///
///
///
/// Container for the necessary parameters to execute the CreateStateMachine service method.
///
/// The response from the CreateStateMachine service method, as returned by StepFunctions.
///
/// Updating or deleting a resource can cause an inconsistent state. This error occurs
/// when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion,
/// or UpdateStateMachine with the publish
parameter set to true
.
///
///
///
/// HTTP Status Code: 409
///
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided Amazon States Language definition is not valid.
///
///
///
///
///
/// The provided name is not valid.
///
///
/// Your tracingConfiguration
key does not match, or enabled
/// has not been set to true
or false
.
///
///
/// A state machine with the same name but a different definition or role ARN already
/// exists.
///
///
/// The specified state machine is being deleted.
///
///
/// The maximum number of state machines has been reached. Existing state machines must
/// be deleted before a new state machine can be created.
///
///
///
///
///
/// You've exceeded the number of tags allowed for a resource. See the
/// Limits Topic in the Step Functions Developer Guide.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for CreateStateMachine Operation
public virtual CreateStateMachineResponse CreateStateMachine(CreateStateMachineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateStateMachineRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateStateMachineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the CreateStateMachine operation.
///
///
/// Container for the necessary parameters to execute the CreateStateMachine operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStateMachine
/// operation.
/// REST API Reference for CreateStateMachine Operation
public virtual IAsyncResult BeginCreateStateMachine(CreateStateMachineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateStateMachineRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateStateMachineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the CreateStateMachine operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateStateMachine.
///
/// Returns a CreateStateMachineResult from StepFunctions.
/// REST API Reference for CreateStateMachine Operation
public virtual CreateStateMachineResponse EndCreateStateMachine(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region CreateStateMachineAlias
///
/// Creates an alias
/// for a state machine that points to one or two versions
/// of the same state machine. You can set your application to call StartExecution
/// with an alias and update the version the alias uses without changing the client's
/// code.
///
///
///
/// You can also map an alias to split StartExecution requests between two versions
/// of a state machine. To do this, add a second RoutingConfig
object in
/// the routingConfiguration
parameter. You must also specify the percentage
/// of execution run requests each version should receive in both RoutingConfig
/// objects. Step Functions randomly chooses which version runs a given execution based
/// on the percentage you specify.
///
///
///
/// To create an alias that points to a single version, specify a single RoutingConfig
/// object with a weight
set to 100.
///
///
///
/// You can create up to 100 aliases for each state machine. You must delete unused aliases
/// using the DeleteStateMachineAlias API action.
///
///
///
/// CreateStateMachineAlias
is an idempotent API. Step Functions bases the
/// idempotency check on the stateMachineArn
, description
, name
,
/// and routingConfiguration
parameters. Requests that contain the same values
/// for these parameters return a successful idempotent response without creating a duplicate
/// resource.
///
///
///
/// Related operations:
///
///
///
/// Container for the necessary parameters to execute the CreateStateMachineAlias service method.
///
/// The response from the CreateStateMachineAlias service method, as returned by StepFunctions.
///
/// Updating or deleting a resource can cause an inconsistent state. This error occurs
/// when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion,
/// or UpdateStateMachine with the publish
parameter set to true
.
///
///
///
/// HTTP Status Code: 409
///
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided name is not valid.
///
///
/// Could not find the referenced resource.
///
///
/// The request would cause a service quota to be exceeded.
///
///
///
/// HTTP Status Code: 402
///
///
///
/// The specified state machine is being deleted.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for CreateStateMachineAlias Operation
public virtual CreateStateMachineAliasResponse CreateStateMachineAlias(CreateStateMachineAliasRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateStateMachineAliasRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateStateMachineAliasResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the CreateStateMachineAlias operation.
///
///
/// Container for the necessary parameters to execute the CreateStateMachineAlias operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateStateMachineAlias
/// operation.
/// REST API Reference for CreateStateMachineAlias Operation
public virtual IAsyncResult BeginCreateStateMachineAlias(CreateStateMachineAliasRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = CreateStateMachineAliasRequestMarshaller.Instance;
options.ResponseUnmarshaller = CreateStateMachineAliasResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the CreateStateMachineAlias operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateStateMachineAlias.
///
/// Returns a CreateStateMachineAliasResult from StepFunctions.
/// REST API Reference for CreateStateMachineAlias Operation
public virtual CreateStateMachineAliasResponse EndCreateStateMachineAlias(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DeleteActivity
///
/// Deletes an activity.
///
/// Container for the necessary parameters to execute the DeleteActivity service method.
///
/// The response from the DeleteActivity service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
/// REST API Reference for DeleteActivity Operation
public virtual DeleteActivityResponse DeleteActivity(DeleteActivityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteActivityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteActivityResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DeleteActivity operation.
///
///
/// Container for the necessary parameters to execute the DeleteActivity operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteActivity
/// operation.
/// REST API Reference for DeleteActivity Operation
public virtual IAsyncResult BeginDeleteActivity(DeleteActivityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteActivityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteActivityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteActivity operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteActivity.
///
/// Returns a DeleteActivityResult from StepFunctions.
/// REST API Reference for DeleteActivity Operation
public virtual DeleteActivityResponse EndDeleteActivity(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DeleteStateMachine
///
/// Deletes a state machine. This is an asynchronous operation: It sets the state machine's
/// status to DELETING
and begins the deletion process.
///
///
///
/// A qualified state machine ARN can either refer to a Distributed Map state defined
/// within a state machine, a version ARN, or an alias ARN.
///
///
///
/// The following are some examples of qualified and unqualified state machine ARNs:
///
/// -
///
/// The following qualified state machine ARN refers to a Distributed Map state
/// with a label
mapStateLabel
in a state machine named myStateMachine
.
///
///
///
/// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
///
///
///
///
/// If you provide a qualified state machine ARN that refers to a Distributed Map state,
/// the request fails with ValidationException
.
///
/// -
///
/// The following unqualified state machine ARN refers to a state machine named
myStateMachine
.
///
///
///
/// arn:partition:states:region:account-id:stateMachine:myStateMachine
///
///
///
/// This API action also deletes all versions
/// and aliases
/// associated with a state machine.
///
///
///
/// For EXPRESS
state machines, the deletion happens eventually (usually
/// in less than a minute). Running executions may emit logs after DeleteStateMachine
/// API is called.
///
///
///
/// Container for the necessary parameters to execute the DeleteStateMachine service method.
///
/// The response from the DeleteStateMachine service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DeleteStateMachine Operation
public virtual DeleteStateMachineResponse DeleteStateMachine(DeleteStateMachineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteStateMachineRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteStateMachineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DeleteStateMachine operation.
///
///
/// Container for the necessary parameters to execute the DeleteStateMachine operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStateMachine
/// operation.
/// REST API Reference for DeleteStateMachine Operation
public virtual IAsyncResult BeginDeleteStateMachine(DeleteStateMachineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteStateMachineRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteStateMachineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteStateMachine operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteStateMachine.
///
/// Returns a DeleteStateMachineResult from StepFunctions.
/// REST API Reference for DeleteStateMachine Operation
public virtual DeleteStateMachineResponse EndDeleteStateMachine(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DeleteStateMachineAlias
///
/// Deletes a state machine alias.
///
///
///
/// After you delete a state machine alias, you can't use it to start executions. When
/// you delete a state machine alias, Step Functions doesn't delete the state machine
/// versions that alias references.
///
///
///
/// Related operations:
///
///
///
/// Container for the necessary parameters to execute the DeleteStateMachineAlias service method.
///
/// The response from the DeleteStateMachineAlias service method, as returned by StepFunctions.
///
/// Updating or deleting a resource can cause an inconsistent state. This error occurs
/// when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion,
/// or UpdateStateMachine with the publish
parameter set to true
.
///
///
///
/// HTTP Status Code: 409
///
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// Could not find the referenced resource.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DeleteStateMachineAlias Operation
public virtual DeleteStateMachineAliasResponse DeleteStateMachineAlias(DeleteStateMachineAliasRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteStateMachineAliasRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteStateMachineAliasResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DeleteStateMachineAlias operation.
///
///
/// Container for the necessary parameters to execute the DeleteStateMachineAlias operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStateMachineAlias
/// operation.
/// REST API Reference for DeleteStateMachineAlias Operation
public virtual IAsyncResult BeginDeleteStateMachineAlias(DeleteStateMachineAliasRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteStateMachineAliasRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteStateMachineAliasResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteStateMachineAlias operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteStateMachineAlias.
///
/// Returns a DeleteStateMachineAliasResult from StepFunctions.
/// REST API Reference for DeleteStateMachineAlias Operation
public virtual DeleteStateMachineAliasResponse EndDeleteStateMachineAlias(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DeleteStateMachineVersion
///
/// Deletes a state machine version.
/// After you delete a version, you can't call StartExecution using that version's
/// ARN or use the version with a state machine alias.
///
///
///
/// Deleting a state machine version won't terminate its in-progress executions.
///
///
///
/// You can't delete a state machine version currently referenced by one or more aliases.
/// Before you delete a version, you must either delete the aliases or update them to
/// point to another state machine version.
///
///
///
/// Related operations:
///
///
///
/// Container for the necessary parameters to execute the DeleteStateMachineVersion service method.
///
/// The response from the DeleteStateMachineVersion service method, as returned by StepFunctions.
///
/// Updating or deleting a resource can cause an inconsistent state. This error occurs
/// when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion,
/// or UpdateStateMachine with the publish
parameter set to true
.
///
///
///
/// HTTP Status Code: 409
///
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DeleteStateMachineVersion Operation
public virtual DeleteStateMachineVersionResponse DeleteStateMachineVersion(DeleteStateMachineVersionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteStateMachineVersionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteStateMachineVersionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DeleteStateMachineVersion operation.
///
///
/// Container for the necessary parameters to execute the DeleteStateMachineVersion operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteStateMachineVersion
/// operation.
/// REST API Reference for DeleteStateMachineVersion Operation
public virtual IAsyncResult BeginDeleteStateMachineVersion(DeleteStateMachineVersionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DeleteStateMachineVersionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DeleteStateMachineVersionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DeleteStateMachineVersion operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteStateMachineVersion.
///
/// Returns a DeleteStateMachineVersionResult from StepFunctions.
/// REST API Reference for DeleteStateMachineVersion Operation
public virtual DeleteStateMachineVersionResponse EndDeleteStateMachineVersion(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DescribeActivity
///
/// Describes an activity.
///
///
///
/// This operation is eventually consistent. The results are best effort and may not reflect
/// very recent updates and changes.
///
///
///
/// Container for the necessary parameters to execute the DescribeActivity service method.
///
/// The response from the DescribeActivity service method, as returned by StepFunctions.
///
/// The specified activity does not exist.
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
/// REST API Reference for DescribeActivity Operation
public virtual DescribeActivityResponse DescribeActivity(DescribeActivityRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeActivityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeActivityResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DescribeActivity operation.
///
///
/// Container for the necessary parameters to execute the DescribeActivity operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeActivity
/// operation.
/// REST API Reference for DescribeActivity Operation
public virtual IAsyncResult BeginDescribeActivity(DescribeActivityRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeActivityRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeActivityResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DescribeActivity operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeActivity.
///
/// Returns a DescribeActivityResult from StepFunctions.
/// REST API Reference for DescribeActivity Operation
public virtual DescribeActivityResponse EndDescribeActivity(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DescribeExecution
///
/// Provides information about a state machine execution, such as the state machine associated
/// with the execution, the execution input and output, and relevant execution metadata.
/// Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution
/// was dispatched by a Map Run.
///
///
///
/// If you specify a version or alias ARN when you call the StartExecution API
/// action, DescribeExecution
returns that ARN.
///
///
///
/// This operation is eventually consistent. The results are best effort and may not reflect
/// very recent updates and changes.
///
///
///
/// Executions of an EXPRESS
state machinearen't supported by DescribeExecution
/// unless a Map Run dispatched them.
///
///
/// Container for the necessary parameters to execute the DescribeExecution service method.
///
/// The response from the DescribeExecution service method, as returned by StepFunctions.
///
/// The specified execution does not exist.
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
/// REST API Reference for DescribeExecution Operation
public virtual DescribeExecutionResponse DescribeExecution(DescribeExecutionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeExecutionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DescribeExecution operation.
///
///
/// Container for the necessary parameters to execute the DescribeExecution operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeExecution
/// operation.
/// REST API Reference for DescribeExecution Operation
public virtual IAsyncResult BeginDescribeExecution(DescribeExecutionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeExecutionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DescribeExecution operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeExecution.
///
/// Returns a DescribeExecutionResult from StepFunctions.
/// REST API Reference for DescribeExecution Operation
public virtual DescribeExecutionResponse EndDescribeExecution(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DescribeMapRun
///
/// Provides information about a Map Run's configuration, progress, and results. For more
/// information, see Examining
/// Map Run in the Step Functions Developer Guide.
///
/// Container for the necessary parameters to execute the DescribeMapRun service method.
///
/// The response from the DescribeMapRun service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// Could not find the referenced resource.
///
/// REST API Reference for DescribeMapRun Operation
public virtual DescribeMapRunResponse DescribeMapRun(DescribeMapRunRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeMapRunRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeMapRunResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DescribeMapRun operation.
///
///
/// Container for the necessary parameters to execute the DescribeMapRun operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeMapRun
/// operation.
/// REST API Reference for DescribeMapRun Operation
public virtual IAsyncResult BeginDescribeMapRun(DescribeMapRunRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeMapRunRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeMapRunResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DescribeMapRun operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeMapRun.
///
/// Returns a DescribeMapRunResult from StepFunctions.
/// REST API Reference for DescribeMapRun Operation
public virtual DescribeMapRunResponse EndDescribeMapRun(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DescribeStateMachine
///
/// Provides information about a state machine's definition, its IAM role Amazon Resource
/// Name (ARN), and configuration.
///
///
///
/// A qualified state machine ARN can either refer to a Distributed Map state defined
/// within a state machine, a version ARN, or an alias ARN.
///
///
///
/// The following are some examples of qualified and unqualified state machine ARNs:
///
/// -
///
/// The following qualified state machine ARN refers to a Distributed Map state
/// with a label
mapStateLabel
in a state machine named myStateMachine
.
///
///
///
/// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
///
///
///
///
/// If you provide a qualified state machine ARN that refers to a Distributed Map state,
/// the request fails with ValidationException
.
///
/// -
///
/// The following qualified state machine ARN refers to an alias named
PROD
.
///
///
///
/// arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
///
///
///
///
/// If you provide a qualified state machine ARN that refers to a version ARN or an alias
/// ARN, the request starts execution for that version or alias.
///
/// -
///
/// The following unqualified state machine ARN refers to a state machine named
myStateMachine
.
///
///
///
/// arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
///
///
///
///
/// This API action returns the details for a state machine version if the stateMachineArn
/// you specify is a state machine version ARN.
///
///
///
/// This operation is eventually consistent. The results are best effort and may not reflect
/// very recent updates and changes.
///
///
///
/// Container for the necessary parameters to execute the DescribeStateMachine service method.
///
/// The response from the DescribeStateMachine service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The specified state machine does not exist.
///
/// REST API Reference for DescribeStateMachine Operation
public virtual DescribeStateMachineResponse DescribeStateMachine(DescribeStateMachineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeStateMachineRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeStateMachineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DescribeStateMachine operation.
///
///
/// Container for the necessary parameters to execute the DescribeStateMachine operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStateMachine
/// operation.
/// REST API Reference for DescribeStateMachine Operation
public virtual IAsyncResult BeginDescribeStateMachine(DescribeStateMachineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeStateMachineRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeStateMachineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DescribeStateMachine operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeStateMachine.
///
/// Returns a DescribeStateMachineResult from StepFunctions.
/// REST API Reference for DescribeStateMachine Operation
public virtual DescribeStateMachineResponse EndDescribeStateMachine(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DescribeStateMachineAlias
///
/// Returns details about a state machine alias.
///
///
///
/// Related operations:
///
///
///
/// Container for the necessary parameters to execute the DescribeStateMachineAlias service method.
///
/// The response from the DescribeStateMachineAlias service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// Could not find the referenced resource.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for DescribeStateMachineAlias Operation
public virtual DescribeStateMachineAliasResponse DescribeStateMachineAlias(DescribeStateMachineAliasRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeStateMachineAliasRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeStateMachineAliasResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DescribeStateMachineAlias operation.
///
///
/// Container for the necessary parameters to execute the DescribeStateMachineAlias operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStateMachineAlias
/// operation.
/// REST API Reference for DescribeStateMachineAlias Operation
public virtual IAsyncResult BeginDescribeStateMachineAlias(DescribeStateMachineAliasRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeStateMachineAliasRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeStateMachineAliasResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DescribeStateMachineAlias operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeStateMachineAlias.
///
/// Returns a DescribeStateMachineAliasResult from StepFunctions.
/// REST API Reference for DescribeStateMachineAlias Operation
public virtual DescribeStateMachineAliasResponse EndDescribeStateMachineAlias(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region DescribeStateMachineForExecution
///
/// Provides information about a state machine's definition, its execution role ARN, and
/// configuration. If a Map Run dispatched the execution, this action returns the Map
/// Run Amazon Resource Name (ARN) in the response. The state machine returned is the
/// state machine associated with the Map Run.
///
///
///
/// 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.
///
///
/// Container for the necessary parameters to execute the DescribeStateMachineForExecution service method.
///
/// The response from the DescribeStateMachineForExecution service method, as returned by StepFunctions.
///
/// The specified execution does not exist.
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
/// REST API Reference for DescribeStateMachineForExecution Operation
public virtual DescribeStateMachineForExecutionResponse DescribeStateMachineForExecution(DescribeStateMachineForExecutionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeStateMachineForExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeStateMachineForExecutionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the DescribeStateMachineForExecution operation.
///
///
/// Container for the necessary parameters to execute the DescribeStateMachineForExecution operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeStateMachineForExecution
/// operation.
/// REST API Reference for DescribeStateMachineForExecution Operation
public virtual IAsyncResult BeginDescribeStateMachineForExecution(DescribeStateMachineForExecutionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = DescribeStateMachineForExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = DescribeStateMachineForExecutionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the DescribeStateMachineForExecution operation.
///
///
/// The IAsyncResult returned by the call to BeginDescribeStateMachineForExecution.
///
/// Returns a DescribeStateMachineForExecutionResult from StepFunctions.
/// REST API Reference for DescribeStateMachineForExecution Operation
public virtual DescribeStateMachineForExecutionResponse EndDescribeStateMachineForExecution(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region GetActivityTask
///
/// 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.
///
///
///
/// This API action isn't logged in CloudTrail.
///
///
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the GetActivityTask service method.
///
/// The response from the GetActivityTask service method, as returned by StepFunctions.
///
/// The specified activity does not exist.
///
///
/// The maximum number of workers concurrently polling for activity tasks has been reached.
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
/// REST API Reference for GetActivityTask Operation
public virtual GetActivityTaskResponse GetActivityTask(GetActivityTaskRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetActivityTaskRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetActivityTaskResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the GetActivityTask operation.
///
///
/// Container for the necessary parameters to execute the GetActivityTask operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetActivityTask
/// operation.
/// REST API Reference for GetActivityTask Operation
public virtual IAsyncResult BeginGetActivityTask(GetActivityTaskRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetActivityTaskRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetActivityTaskResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetActivityTask operation.
///
///
/// The IAsyncResult returned by the call to BeginGetActivityTask.
///
/// Returns a GetActivityTaskResult from StepFunctions.
/// REST API Reference for GetActivityTask Operation
public virtual GetActivityTaskResponse EndGetActivityTask(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region GetExecutionHistory
///
/// 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.
///
///
/// Container for the necessary parameters to execute the GetExecutionHistory service method.
///
/// The response from the GetExecutionHistory service method, as returned by StepFunctions.
///
/// The specified execution does not exist.
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided token is not valid.
///
/// REST API Reference for GetExecutionHistory Operation
public virtual GetExecutionHistoryResponse GetExecutionHistory(GetExecutionHistoryRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetExecutionHistoryRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetExecutionHistoryResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the GetExecutionHistory operation.
///
///
/// Container for the necessary parameters to execute the GetExecutionHistory operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetExecutionHistory
/// operation.
/// REST API Reference for GetExecutionHistory Operation
public virtual IAsyncResult BeginGetExecutionHistory(GetExecutionHistoryRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = GetExecutionHistoryRequestMarshaller.Instance;
options.ResponseUnmarshaller = GetExecutionHistoryResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the GetExecutionHistory operation.
///
///
/// The IAsyncResult returned by the call to BeginGetExecutionHistory.
///
/// Returns a GetExecutionHistoryResult from StepFunctions.
/// REST API Reference for GetExecutionHistory Operation
public virtual GetExecutionHistoryResponse EndGetExecutionHistory(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region ListActivities
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the ListActivities service method.
///
/// The response from the ListActivities service method, as returned by StepFunctions.
///
/// The provided token is not valid.
///
/// REST API Reference for ListActivities Operation
public virtual ListActivitiesResponse ListActivities(ListActivitiesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListActivitiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListActivitiesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListActivities operation.
///
///
/// Container for the necessary parameters to execute the ListActivities operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListActivities
/// operation.
/// REST API Reference for ListActivities Operation
public virtual IAsyncResult BeginListActivities(ListActivitiesRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListActivitiesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListActivitiesResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListActivities operation.
///
///
/// The IAsyncResult returned by the call to BeginListActivities.
///
/// Returns a ListActivitiesResult from StepFunctions.
/// REST API Reference for ListActivities Operation
public virtual ListActivitiesResponse EndListActivities(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region ListExecutions
///
/// Lists all executions of a state machine or a Map Run. You can list all executions
/// related to a state machine by specifying a state machine Amazon Resource Name (ARN),
/// or those related to a Map Run by specifying a Map Run ARN.
///
///
///
/// You can also provide a state machine alias
/// ARN or version
/// ARN to list the executions associated with a specific alias or version.
///
///
///
/// 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.
///
///
/// Container for the necessary parameters to execute the ListExecutions service method.
///
/// The response from the ListExecutions service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided token is not valid.
///
///
/// Could not find the referenced resource.
///
///
/// The specified state machine does not exist.
///
///
///
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListExecutions Operation
public virtual ListExecutionsResponse ListExecutions(ListExecutionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListExecutionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListExecutionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListExecutions operation.
///
///
/// Container for the necessary parameters to execute the ListExecutions operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListExecutions
/// operation.
/// REST API Reference for ListExecutions Operation
public virtual IAsyncResult BeginListExecutions(ListExecutionsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListExecutionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListExecutionsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListExecutions operation.
///
///
/// The IAsyncResult returned by the call to BeginListExecutions.
///
/// Returns a ListExecutionsResult from StepFunctions.
/// REST API Reference for ListExecutions Operation
public virtual ListExecutionsResponse EndListExecutions(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region ListMapRuns
///
/// Lists all Map Runs that were started by a given state machine execution. Use this
/// API action to obtain Map Run ARNs, and then call DescribeMapRun
to obtain
/// more information, if needed.
///
/// Container for the necessary parameters to execute the ListMapRuns service method.
///
/// The response from the ListMapRuns service method, as returned by StepFunctions.
///
/// The specified execution does not exist.
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided token is not valid.
///
/// REST API Reference for ListMapRuns Operation
public virtual ListMapRunsResponse ListMapRuns(ListMapRunsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListMapRunsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListMapRunsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListMapRuns operation.
///
///
/// Container for the necessary parameters to execute the ListMapRuns operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListMapRuns
/// operation.
/// REST API Reference for ListMapRuns Operation
public virtual IAsyncResult BeginListMapRuns(ListMapRunsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListMapRunsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListMapRunsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListMapRuns operation.
///
///
/// The IAsyncResult returned by the call to BeginListMapRuns.
///
/// Returns a ListMapRunsResult from StepFunctions.
/// REST API Reference for ListMapRuns Operation
public virtual ListMapRunsResponse EndListMapRuns(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region ListStateMachineAliases
///
/// Lists aliases
/// for a specified state machine ARN. Results are sorted by time, with the most recently
/// created aliases listed first.
///
///
///
/// To list aliases that reference a state machine version,
/// you can specify the version ARN in the stateMachineArn
parameter.
///
///
///
/// 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.
///
///
///
/// Related operations:
///
///
///
/// Container for the necessary parameters to execute the ListStateMachineAliases service method.
///
/// The response from the ListStateMachineAliases service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided token is not valid.
///
///
/// Could not find the referenced resource.
///
///
/// The specified state machine is being deleted.
///
///
/// The specified state machine does not exist.
///
/// REST API Reference for ListStateMachineAliases Operation
public virtual ListStateMachineAliasesResponse ListStateMachineAliases(ListStateMachineAliasesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListStateMachineAliasesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListStateMachineAliasesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListStateMachineAliases operation.
///
///
/// Container for the necessary parameters to execute the ListStateMachineAliases operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStateMachineAliases
/// operation.
/// REST API Reference for ListStateMachineAliases Operation
public virtual IAsyncResult BeginListStateMachineAliases(ListStateMachineAliasesRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListStateMachineAliasesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListStateMachineAliasesResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListStateMachineAliases operation.
///
///
/// The IAsyncResult returned by the call to BeginListStateMachineAliases.
///
/// Returns a ListStateMachineAliasesResult from StepFunctions.
/// REST API Reference for ListStateMachineAliases Operation
public virtual ListStateMachineAliasesResponse EndListStateMachineAliases(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region ListStateMachines
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the ListStateMachines service method.
///
/// The response from the ListStateMachines service method, as returned by StepFunctions.
///
/// The provided token is not valid.
///
/// REST API Reference for ListStateMachines Operation
public virtual ListStateMachinesResponse ListStateMachines(ListStateMachinesRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListStateMachinesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListStateMachinesResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListStateMachines operation.
///
///
/// Container for the necessary parameters to execute the ListStateMachines operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStateMachines
/// operation.
/// REST API Reference for ListStateMachines Operation
public virtual IAsyncResult BeginListStateMachines(ListStateMachinesRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListStateMachinesRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListStateMachinesResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListStateMachines operation.
///
///
/// The IAsyncResult returned by the call to BeginListStateMachines.
///
/// Returns a ListStateMachinesResult from StepFunctions.
/// REST API Reference for ListStateMachines Operation
public virtual ListStateMachinesResponse EndListStateMachines(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region ListStateMachineVersions
///
/// Lists versions
/// for the specified state machine Amazon Resource Name (ARN).
///
///
///
/// The results are sorted in descending order of the version creation time.
///
///
///
/// 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.
///
///
///
/// Related operations:
///
///
///
/// Container for the necessary parameters to execute the ListStateMachineVersions service method.
///
/// The response from the ListStateMachineVersions service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided token is not valid.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for ListStateMachineVersions Operation
public virtual ListStateMachineVersionsResponse ListStateMachineVersions(ListStateMachineVersionsRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListStateMachineVersionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListStateMachineVersionsResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListStateMachineVersions operation.
///
///
/// Container for the necessary parameters to execute the ListStateMachineVersions operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListStateMachineVersions
/// operation.
/// REST API Reference for ListStateMachineVersions Operation
public virtual IAsyncResult BeginListStateMachineVersions(ListStateMachineVersionsRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListStateMachineVersionsRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListStateMachineVersionsResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListStateMachineVersions operation.
///
///
/// The IAsyncResult returned by the call to BeginListStateMachineVersions.
///
/// Returns a ListStateMachineVersionsResult from StepFunctions.
/// REST API Reference for ListStateMachineVersions Operation
public virtual ListStateMachineVersionsResponse EndListStateMachineVersions(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region ListTagsForResource
///
/// List tags for a given resource.
///
///
///
/// Tags may only contain Unicode letters, digits, white space, or these symbols: _
/// . : / = + - @
.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// Could not find the referenced resource.
///
/// REST API Reference for ListTagsForResource Operation
public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource
/// operation.
/// REST API Reference for ListTagsForResource Operation
public virtual IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = ListTagsForResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = ListTagsForResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the ListTagsForResource operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForResource.
///
/// Returns a ListTagsForResourceResult from StepFunctions.
/// REST API Reference for ListTagsForResource Operation
public virtual ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region PublishStateMachineVersion
///
/// Creates a version
/// from the current revision of a state machine. Use versions to create immutable snapshots
/// of your state machine. You can start executions from versions either directly or with
/// an alias. To create an alias, use CreateStateMachineAlias.
///
///
///
/// You can publish up to 1000 versions for each state machine. You must manually delete
/// unused versions using the DeleteStateMachineVersion API action.
///
///
///
/// PublishStateMachineVersion
is an idempotent API. It doesn't create a
/// duplicate state machine version if it already exists for the current revision. Step
/// Functions bases PublishStateMachineVersion
's idempotency check on the
/// stateMachineArn
, name
, and revisionId
parameters.
/// Requests with the same parameters return a successful idempotent response. If you
/// don't specify a revisionId
, Step Functions checks for a previously published
/// version of the state machine's current revision.
///
///
///
/// Related operations:
///
///
///
/// Container for the necessary parameters to execute the PublishStateMachineVersion service method.
///
/// The response from the PublishStateMachineVersion service method, as returned by StepFunctions.
///
/// Updating or deleting a resource can cause an inconsistent state. This error occurs
/// when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion,
/// or UpdateStateMachine with the publish
parameter set to true
.
///
///
///
/// HTTP Status Code: 409
///
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The request would cause a service quota to be exceeded.
///
///
///
/// HTTP Status Code: 402
///
///
///
/// The specified state machine is being deleted.
///
///
/// The specified state machine does not exist.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for PublishStateMachineVersion Operation
public virtual PublishStateMachineVersionResponse PublishStateMachineVersion(PublishStateMachineVersionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = PublishStateMachineVersionRequestMarshaller.Instance;
options.ResponseUnmarshaller = PublishStateMachineVersionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the PublishStateMachineVersion operation.
///
///
/// Container for the necessary parameters to execute the PublishStateMachineVersion operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPublishStateMachineVersion
/// operation.
/// REST API Reference for PublishStateMachineVersion Operation
public virtual IAsyncResult BeginPublishStateMachineVersion(PublishStateMachineVersionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = PublishStateMachineVersionRequestMarshaller.Instance;
options.ResponseUnmarshaller = PublishStateMachineVersionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the PublishStateMachineVersion operation.
///
///
/// The IAsyncResult returned by the call to BeginPublishStateMachineVersion.
///
/// Returns a PublishStateMachineVersionResult from StepFunctions.
/// REST API Reference for PublishStateMachineVersion Operation
public virtual PublishStateMachineVersionResponse EndPublishStateMachineVersion(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region SendTaskFailure
///
/// Used by activity workers and task states using the callback
/// pattern to report that the task identified by the taskToken
failed.
///
/// Container for the necessary parameters to execute the SendTaskFailure service method.
///
/// The response from the SendTaskFailure service method, as returned by StepFunctions.
///
/// The provided token is not valid.
///
///
///
///
///
///
///
/// REST API Reference for SendTaskFailure Operation
public virtual SendTaskFailureResponse SendTaskFailure(SendTaskFailureRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = SendTaskFailureRequestMarshaller.Instance;
options.ResponseUnmarshaller = SendTaskFailureResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the SendTaskFailure operation.
///
///
/// Container for the necessary parameters to execute the SendTaskFailure operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSendTaskFailure
/// operation.
/// REST API Reference for SendTaskFailure Operation
public virtual IAsyncResult BeginSendTaskFailure(SendTaskFailureRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = SendTaskFailureRequestMarshaller.Instance;
options.ResponseUnmarshaller = SendTaskFailureResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the SendTaskFailure operation.
///
///
/// The IAsyncResult returned by the call to BeginSendTaskFailure.
///
/// Returns a SendTaskFailureResult from StepFunctions.
/// REST API Reference for SendTaskFailure Operation
public virtual SendTaskFailureResponse EndSendTaskFailure(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region SendTaskHeartbeat
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the SendTaskHeartbeat service method.
///
/// The response from the SendTaskHeartbeat service method, as returned by StepFunctions.
///
/// The provided token is not valid.
///
///
///
///
///
///
///
/// REST API Reference for SendTaskHeartbeat Operation
public virtual SendTaskHeartbeatResponse SendTaskHeartbeat(SendTaskHeartbeatRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = SendTaskHeartbeatRequestMarshaller.Instance;
options.ResponseUnmarshaller = SendTaskHeartbeatResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the SendTaskHeartbeat operation.
///
///
/// Container for the necessary parameters to execute the SendTaskHeartbeat operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSendTaskHeartbeat
/// operation.
/// REST API Reference for SendTaskHeartbeat Operation
public virtual IAsyncResult BeginSendTaskHeartbeat(SendTaskHeartbeatRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = SendTaskHeartbeatRequestMarshaller.Instance;
options.ResponseUnmarshaller = SendTaskHeartbeatResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the SendTaskHeartbeat operation.
///
///
/// The IAsyncResult returned by the call to BeginSendTaskHeartbeat.
///
/// Returns a SendTaskHeartbeatResult from StepFunctions.
/// REST API Reference for SendTaskHeartbeat Operation
public virtual SendTaskHeartbeatResponse EndSendTaskHeartbeat(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region SendTaskSuccess
///
/// Used by activity workers and task states using the callback
/// pattern to report that the task identified by the taskToken
completed
/// successfully.
///
/// Container for the necessary parameters to execute the SendTaskSuccess service method.
///
/// The response from the SendTaskSuccess service method, as returned by StepFunctions.
///
/// The provided JSON output data is not valid.
///
///
/// The provided token is not valid.
///
///
///
///
///
///
///
/// REST API Reference for SendTaskSuccess Operation
public virtual SendTaskSuccessResponse SendTaskSuccess(SendTaskSuccessRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = SendTaskSuccessRequestMarshaller.Instance;
options.ResponseUnmarshaller = SendTaskSuccessResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the SendTaskSuccess operation.
///
///
/// Container for the necessary parameters to execute the SendTaskSuccess operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSendTaskSuccess
/// operation.
/// REST API Reference for SendTaskSuccess Operation
public virtual IAsyncResult BeginSendTaskSuccess(SendTaskSuccessRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = SendTaskSuccessRequestMarshaller.Instance;
options.ResponseUnmarshaller = SendTaskSuccessResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the SendTaskSuccess operation.
///
///
/// The IAsyncResult returned by the call to BeginSendTaskSuccess.
///
/// Returns a SendTaskSuccessResult from StepFunctions.
/// REST API Reference for SendTaskSuccess Operation
public virtual SendTaskSuccessResponse EndSendTaskSuccess(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region StartExecution
///
/// Starts a state machine execution.
///
///
///
/// A qualified state machine ARN can either refer to a Distributed Map state defined
/// within a state machine, a version ARN, or an alias ARN.
///
///
///
/// The following are some examples of qualified and unqualified state machine ARNs:
///
/// -
///
/// The following qualified state machine ARN refers to a Distributed Map state
/// with a label
mapStateLabel
in a state machine named myStateMachine
.
///
///
///
/// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
///
///
///
///
/// If you provide a qualified state machine ARN that refers to a Distributed Map state,
/// the request fails with ValidationException
.
///
/// -
///
/// The following qualified state machine ARN refers to an alias named
PROD
.
///
///
///
/// arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
///
///
///
///
/// If you provide a qualified state machine ARN that refers to a version ARN or an alias
/// ARN, the request starts execution for that version or alias.
///
/// -
///
/// The following unqualified state machine ARN refers to a state machine named
myStateMachine
.
///
///
///
/// arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
///
///
///
///
/// If you start an execution with an unqualified state machine ARN, Step Functions uses
/// the latest revision of the state machine for the execution.
///
///
///
/// To start executions of a state machine version,
/// call StartExecution
and provide the version ARN or the ARN of an alias
/// that points to the version.
///
///
///
/// StartExecution
is idempotent for STANDARD
workflows. For
/// a STANDARD
workflow, if you call StartExecution
with the
/// same name and input as a running execution, the call succeeds and return the same
/// response as the original request. If the execution is closed or if the input is different,
/// it returns a 400 ExecutionAlreadyExists
error. You can reuse names after
/// 90 days.
///
///
///
/// StartExecution
isn't idempotent for EXPRESS
workflows.
///
///
///
///
/// Container for the necessary parameters to execute the StartExecution service method.
///
/// The response from the StartExecution service method, as returned by StepFunctions.
///
/// The execution has the same name
as another execution (but a different
/// input
).
///
///
///
/// Executions with the same name
and input
are considered idempotent.
///
///
///
///
/// The maximum number of running executions has been reached. Running executions must
/// end or be stopped before a new execution can be started.
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided JSON input data is not valid.
///
///
/// The provided name is not valid.
///
///
/// The specified state machine is being deleted.
///
///
/// The specified state machine does not exist.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for StartExecution Operation
public virtual StartExecutionResponse StartExecution(StartExecutionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartExecutionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the StartExecution operation.
///
///
/// Container for the necessary parameters to execute the StartExecution operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartExecution
/// operation.
/// REST API Reference for StartExecution Operation
public virtual IAsyncResult BeginStartExecution(StartExecutionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartExecutionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the StartExecution operation.
///
///
/// The IAsyncResult returned by the call to BeginStartExecution.
///
/// Returns a StartExecutionResult from StepFunctions.
/// REST API Reference for StartExecution Operation
public virtual StartExecutionResponse EndStartExecution(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region StartSyncExecution
///
/// Starts a Synchronous Express state machine execution. StartSyncExecution
/// is not available for STANDARD
workflows.
///
///
///
/// StartSyncExecution
will return a 200 OK
response, even
/// if your execution fails, because the status code in the API response doesn't reflect
/// function errors. Error codes are reserved for errors that prevent your execution from
/// running, such as permissions errors, limit errors, or issues with your state machine
/// code and configuration.
///
///
///
/// This API action isn't logged in CloudTrail.
///
///
///
/// Container for the necessary parameters to execute the StartSyncExecution service method.
///
/// The response from the StartSyncExecution service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided JSON input data is not valid.
///
///
/// The provided name is not valid.
///
///
/// The specified state machine is being deleted.
///
///
/// The specified state machine does not exist.
///
///
///
///
/// REST API Reference for StartSyncExecution Operation
public virtual StartSyncExecutionResponse StartSyncExecution(StartSyncExecutionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartSyncExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartSyncExecutionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the StartSyncExecution operation.
///
///
/// Container for the necessary parameters to execute the StartSyncExecution operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartSyncExecution
/// operation.
/// REST API Reference for StartSyncExecution Operation
public virtual IAsyncResult BeginStartSyncExecution(StartSyncExecutionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = StartSyncExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = StartSyncExecutionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the StartSyncExecution operation.
///
///
/// The IAsyncResult returned by the call to BeginStartSyncExecution.
///
/// Returns a StartSyncExecutionResult from StepFunctions.
/// REST API Reference for StartSyncExecution Operation
public virtual StartSyncExecutionResponse EndStartSyncExecution(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region StopExecution
///
/// Stops an execution.
///
///
///
/// This API action is not supported by EXPRESS
state machines.
///
///
/// Container for the necessary parameters to execute the StopExecution service method.
///
/// The response from the StopExecution service method, as returned by StepFunctions.
///
/// The specified execution does not exist.
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for StopExecution Operation
public virtual StopExecutionResponse StopExecution(StopExecutionRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = StopExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopExecutionResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the StopExecution operation.
///
///
/// Container for the necessary parameters to execute the StopExecution operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopExecution
/// operation.
/// REST API Reference for StopExecution Operation
public virtual IAsyncResult BeginStopExecution(StopExecutionRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = StopExecutionRequestMarshaller.Instance;
options.ResponseUnmarshaller = StopExecutionResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the StopExecution operation.
///
///
/// The IAsyncResult returned by the call to BeginStopExecution.
///
/// Returns a StopExecutionResult from StepFunctions.
/// REST API Reference for StopExecution Operation
public virtual StopExecutionResponse EndStopExecution(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region TagResource
///
/// Add a tag to a Step Functions resource.
///
///
///
/// An array of key-value pairs. For more information, see Using
/// Cost Allocation Tags in the Amazon Web Services Billing and Cost Management
/// User Guide, and Controlling
/// Access Using IAM Tags.
///
///
///
/// Tags may only contain Unicode letters, digits, white space, or these symbols: _
/// . : / = + - @
.
///
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// Could not find the referenced resource.
///
///
/// You've exceeded the number of tags allowed for a resource. See the
/// Limits Topic in the Step Functions Developer Guide.
///
/// REST API Reference for TagResource Operation
public virtual TagResourceResponse TagResource(TagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource
/// operation.
/// REST API Reference for TagResource Operation
public virtual IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = TagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = TagResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the TagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginTagResource.
///
/// Returns a TagResourceResult from StepFunctions.
/// REST API Reference for TagResource Operation
public virtual TagResourceResponse EndTagResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region UntagResource
///
/// Remove a tag from a Step Functions resource
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// Could not find the referenced resource.
///
/// REST API Reference for UntagResource Operation
public virtual UntagResourceResponse UntagResource(UntagResourceRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource
/// operation.
/// REST API Reference for UntagResource Operation
public virtual IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UntagResourceRequestMarshaller.Instance;
options.ResponseUnmarshaller = UntagResourceResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the UntagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagResource.
///
/// Returns a UntagResourceResult from StepFunctions.
/// REST API Reference for UntagResource Operation
public virtual UntagResourceResponse EndUntagResource(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region UpdateMapRun
///
/// Updates an in-progress Map Run's configuration to include changes to the settings
/// that control maximum concurrency and Map Run failure.
///
/// Container for the necessary parameters to execute the UpdateMapRun service method.
///
/// The response from the UpdateMapRun service method, as returned by StepFunctions.
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// Could not find the referenced resource.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for UpdateMapRun Operation
public virtual UpdateMapRunResponse UpdateMapRun(UpdateMapRunRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateMapRunRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateMapRunResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the UpdateMapRun operation.
///
///
/// Container for the necessary parameters to execute the UpdateMapRun operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateMapRun
/// operation.
/// REST API Reference for UpdateMapRun Operation
public virtual IAsyncResult BeginUpdateMapRun(UpdateMapRunRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateMapRunRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateMapRunResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the UpdateMapRun operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateMapRun.
///
/// Returns a UpdateMapRunResult from StepFunctions.
/// REST API Reference for UpdateMapRun Operation
public virtual UpdateMapRunResponse EndUpdateMapRun(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region UpdateStateMachine
///
/// 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.
///
///
///
/// A qualified state machine ARN refers to a Distributed Map state defined within
/// a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel
/// refers to a Distributed Map state with a label mapStateLabel
in
/// the state machine named stateMachineName
.
///
///
///
/// A qualified state machine ARN can either refer to a Distributed Map state defined
/// within a state machine, a version ARN, or an alias ARN.
///
///
///
/// The following are some examples of qualified and unqualified state machine ARNs:
///
/// -
///
/// The following qualified state machine ARN refers to a Distributed Map state
/// with a label
mapStateLabel
in a state machine named myStateMachine
.
///
///
///
/// arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel
///
///
///
///
/// If you provide a qualified state machine ARN that refers to a Distributed Map state,
/// the request fails with ValidationException
.
///
/// -
///
/// The following qualified state machine ARN refers to an alias named
PROD
.
///
///
///
/// arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>
///
///
///
///
/// If you provide a qualified state machine ARN that refers to a version ARN or an alias
/// ARN, the request starts execution for that version or alias.
///
/// -
///
/// The following unqualified state machine ARN refers to a state machine named
myStateMachine
.
///
///
///
/// arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>
///
///
///
///
/// After you update your state machine, you can set the publish
parameter
/// to true
in the same action to publish a new version.
/// This way, you can opt-in to strict versioning of your state machine.
///
///
///
/// Step Functions assigns monotonically increasing integers for state machine versions,
/// starting at version number 1.
///
///
///
/// All StartExecution
calls within a few seconds use the updated definition
/// and roleArn
. Executions started immediately after you call UpdateStateMachine
/// may use the previous state machine definition
and roleArn
.
///
///
///
///
/// Container for the necessary parameters to execute the UpdateStateMachine service method.
///
/// The response from the UpdateStateMachine service method, as returned by StepFunctions.
///
/// Updating or deleting a resource can cause an inconsistent state. This error occurs
/// when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion,
/// or UpdateStateMachine with the publish
parameter set to true
.
///
///
///
/// HTTP Status Code: 409
///
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// The provided Amazon States Language definition is not valid.
///
///
///
///
///
/// Your tracingConfiguration
key does not match, or enabled
/// has not been set to true
or false
.
///
///
/// Request is missing a required parameter. This error occurs if both definition
/// and roleArn
are not specified.
///
///
/// The request would cause a service quota to be exceeded.
///
///
///
/// HTTP Status Code: 402
///
///
///
/// The specified state machine is being deleted.
///
///
/// The specified state machine does not exist.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for UpdateStateMachine Operation
public virtual UpdateStateMachineResponse UpdateStateMachine(UpdateStateMachineRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateStateMachineRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateStateMachineResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the UpdateStateMachine operation.
///
///
/// Container for the necessary parameters to execute the UpdateStateMachine operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStateMachine
/// operation.
/// REST API Reference for UpdateStateMachine Operation
public virtual IAsyncResult BeginUpdateStateMachine(UpdateStateMachineRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateStateMachineRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateStateMachineResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the UpdateStateMachine operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateStateMachine.
///
/// Returns a UpdateStateMachineResult from StepFunctions.
/// REST API Reference for UpdateStateMachine Operation
public virtual UpdateStateMachineResponse EndUpdateStateMachine(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
#region UpdateStateMachineAlias
///
/// Updates the configuration of an existing state machine alias
/// by modifying its description
or routingConfiguration
.
///
///
///
/// You must specify at least one of the description
or routingConfiguration
/// parameters to update a state machine alias.
///
///
///
/// UpdateStateMachineAlias
is an idempotent API. Step Functions bases the
/// idempotency check on the stateMachineAliasArn
, description
,
/// and routingConfiguration
parameters. Requests with the same parameters
/// return an idempotent response.
///
///
///
/// This operation is eventually consistent. All StartExecution requests made within
/// a few seconds use the latest alias configuration. Executions started immediately after
/// calling UpdateStateMachineAlias
may use the previous routing configuration.
///
///
///
/// Related operations:
///
///
///
/// Container for the necessary parameters to execute the UpdateStateMachineAlias service method.
///
/// The response from the UpdateStateMachineAlias service method, as returned by StepFunctions.
///
/// Updating or deleting a resource can cause an inconsistent state. This error occurs
/// when there're concurrent requests for DeleteStateMachineVersion, PublishStateMachineVersion,
/// or UpdateStateMachine with the publish
parameter set to true
.
///
///
///
/// HTTP Status Code: 409
///
///
///
/// The provided Amazon Resource Name (ARN) is not valid.
///
///
/// Could not find the referenced resource.
///
///
/// The input does not satisfy the constraints specified by an Amazon Web Services service.
///
/// REST API Reference for UpdateStateMachineAlias Operation
public virtual UpdateStateMachineAliasResponse UpdateStateMachineAlias(UpdateStateMachineAliasRequest request)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateStateMachineAliasRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateStateMachineAliasResponseUnmarshaller.Instance;
return Invoke(request, options);
}
///
/// Initiates the asynchronous execution of the UpdateStateMachineAlias operation.
///
///
/// Container for the necessary parameters to execute the UpdateStateMachineAlias operation on AmazonStepFunctionsClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateStateMachineAlias
/// operation.
/// REST API Reference for UpdateStateMachineAlias Operation
public virtual IAsyncResult BeginUpdateStateMachineAlias(UpdateStateMachineAliasRequest request, AsyncCallback callback, object state)
{
var options = new InvokeOptions();
options.RequestMarshaller = UpdateStateMachineAliasRequestMarshaller.Instance;
options.ResponseUnmarshaller = UpdateStateMachineAliasResponseUnmarshaller.Instance;
return BeginInvoke(request, options, callback, state);
}
///
/// Finishes the asynchronous execution of the UpdateStateMachineAlias operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateStateMachineAlias.
///
/// Returns a UpdateStateMachineAliasResult from StepFunctions.
/// REST API Reference for UpdateStateMachineAlias Operation
public virtual UpdateStateMachineAliasResponse EndUpdateStateMachineAlias(IAsyncResult asyncResult)
{
return EndInvoke(asyncResult);
}
#endregion
}
}