StartFlowRequest Class | AWS SDK for .NET V3

Container for the parameters to the StartFlow operation. Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Appflow.AmazonAppflowRequest
      Amazon.Appflow.Model.StartFlowRequest

Namespace: Amazon.Appflow.Model
Assembly: AWSSDK.Appflow.dll
Version: 3.x.y.z

Syntax

public class StartFlowRequest : AmazonAppflowRequest
         IAmazonWebServiceRequest

The StartFlowRequest type exposes the following members

Constructors

	Name	Description
	StartFlowRequest()

Properties

Name Type Description

	Name	Type	Description
	ClientToken	System.String	Gets and sets the property ClientToken. The `clientToken` parameter is an idempotency token. It ensures that your `StartFlow` request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same `clientToken` parameter value. If you omit a `clientToken` value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the `triggerConfig` parameter. If you use a different value for `clientToken`, Amazon AppFlow considers it a new call to `StartFlow`. The token is active for 8 hours.
	FlowName	System.String	Gets and sets the property FlowName. The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

ClientToken

System.String

Gets and sets the property ClientToken.

The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter.

If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.

FlowName

System.String

Gets and sets the property FlowName.

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5