Struct aws_sdk_appflow::operation::start_flow::StartFlowInput
source · #[non_exhaustive]pub struct StartFlowInput {
pub flow_name: Option<String>,
pub client_token: Option<String>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.flow_name: Option<String>
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
client_token: Option<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.
Implementations§
source§impl StartFlowInput
impl StartFlowInput
sourcepub fn flow_name(&self) -> Option<&str>
pub fn flow_name(&self) -> Option<&str>
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
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.
source§impl StartFlowInput
impl StartFlowInput
sourcepub fn builder() -> StartFlowInputBuilder
pub fn builder() -> StartFlowInputBuilder
Creates a new builder-style object to manufacture StartFlowInput
.
Trait Implementations§
source§impl Clone for StartFlowInput
impl Clone for StartFlowInput
source§fn clone(&self) -> StartFlowInput
fn clone(&self) -> StartFlowInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for StartFlowInput
impl Debug for StartFlowInput
source§impl PartialEq for StartFlowInput
impl PartialEq for StartFlowInput
source§fn eq(&self, other: &StartFlowInput) -> bool
fn eq(&self, other: &StartFlowInput) -> bool
self
and other
values to be equal, and is used
by ==
.