Class: Aws::Appflow::Types::StartFlowRequest

Inherits:

Struct

• Object
• Struct
• Aws::Appflow::Types::StartFlowRequest

Includes:

Structure

Defined in:

lib/aws-sdk-appflow/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  The ‘clientToken` parameter is an idempotency token.

• #flow_name ⇒ String

  The specified name of the flow.

Instance Attribute Details

#client_token ⇒ String

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.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-appflow/types.rb', line 5257

class StartFlowRequest < Struct.new(
  :flow_name,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#flow_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-appflow/types.rb', line 5257

class StartFlowRequest < Struct.new(
  :flow_name,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end