aws_sdk_sfn/operation/start_sync_execution/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_sync_execution::_start_sync_execution_output::StartSyncExecutionOutputBuilder;
3
4pub use crate::operation::start_sync_execution::_start_sync_execution_input::StartSyncExecutionInputBuilder;
5
6impl crate::operation::start_sync_execution::builders::StartSyncExecutionInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::start_sync_execution::StartSyncExecutionOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::start_sync_execution::StartSyncExecutionError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.start_sync_execution();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `StartSyncExecution`.
24///
25/// <p>Starts a Synchronous Express state machine execution. <code>StartSyncExecution</code> is not available for <code>STANDARD</code> workflows.</p><note>
26/// <p><code>StartSyncExecution</code> will return a <code>200 OK</code> 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.</p>
27/// </note> <note>
28/// <p>This API action isn't logged in CloudTrail.</p>
29/// </note>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct StartSyncExecutionFluentBuilder {
32 handle: ::std::sync::Arc<crate::client::Handle>,
33 inner: crate::operation::start_sync_execution::builders::StartSyncExecutionInputBuilder,
34 config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37 crate::client::customize::internal::CustomizableSend<
38 crate::operation::start_sync_execution::StartSyncExecutionOutput,
39 crate::operation::start_sync_execution::StartSyncExecutionError,
40 > for StartSyncExecutionFluentBuilder
41{
42 fn send(
43 self,
44 config_override: crate::config::Builder,
45 ) -> crate::client::customize::internal::BoxFuture<
46 crate::client::customize::internal::SendResult<
47 crate::operation::start_sync_execution::StartSyncExecutionOutput,
48 crate::operation::start_sync_execution::StartSyncExecutionError,
49 >,
50 > {
51 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52 }
53}
54impl StartSyncExecutionFluentBuilder {
55 /// Creates a new `StartSyncExecutionFluentBuilder`.
56 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57 Self {
58 handle,
59 inner: ::std::default::Default::default(),
60 config_override: ::std::option::Option::None,
61 }
62 }
63 /// Access the StartSyncExecution as a reference.
64 pub fn as_input(&self) -> &crate::operation::start_sync_execution::builders::StartSyncExecutionInputBuilder {
65 &self.inner
66 }
67 /// Sends the request and returns the response.
68 ///
69 /// If an error occurs, an `SdkError` will be returned with additional details that
70 /// can be matched against.
71 ///
72 /// By default, any retryable failures will be retried twice. Retry behavior
73 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74 /// set when configuring the client.
75 pub async fn send(
76 self,
77 ) -> ::std::result::Result<
78 crate::operation::start_sync_execution::StartSyncExecutionOutput,
79 ::aws_smithy_runtime_api::client::result::SdkError<
80 crate::operation::start_sync_execution::StartSyncExecutionError,
81 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82 >,
83 > {
84 let input = self
85 .inner
86 .build()
87 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88 let runtime_plugins = crate::operation::start_sync_execution::StartSyncExecution::operation_runtime_plugins(
89 self.handle.runtime_plugins.clone(),
90 &self.handle.conf,
91 self.config_override,
92 );
93 crate::operation::start_sync_execution::StartSyncExecution::orchestrate(&runtime_plugins, input).await
94 }
95
96 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97 pub fn customize(
98 self,
99 ) -> crate::client::customize::CustomizableOperation<
100 crate::operation::start_sync_execution::StartSyncExecutionOutput,
101 crate::operation::start_sync_execution::StartSyncExecutionError,
102 Self,
103 > {
104 crate::client::customize::CustomizableOperation::new(self)
105 }
106 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107 self.set_config_override(::std::option::Option::Some(config_override.into()));
108 self
109 }
110
111 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112 self.config_override = config_override;
113 self
114 }
115 /// <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
116 pub fn state_machine_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117 self.inner = self.inner.state_machine_arn(input.into());
118 self
119 }
120 /// <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
121 pub fn set_state_machine_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122 self.inner = self.inner.set_state_machine_arn(input);
123 self
124 }
125 /// <p>The Amazon Resource Name (ARN) of the state machine to execute.</p>
126 pub fn get_state_machine_arn(&self) -> &::std::option::Option<::std::string::String> {
127 self.inner.get_state_machine_arn()
128 }
129 /// <p>The name of the execution.</p>
130 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
131 self.inner = self.inner.name(input.into());
132 self
133 }
134 /// <p>The name of the execution.</p>
135 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
136 self.inner = self.inner.set_name(input);
137 self
138 }
139 /// <p>The name of the execution.</p>
140 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
141 self.inner.get_name()
142 }
143 /// <p>The string that contains the JSON input data for the execution, for example:</p>
144 /// <p><code>"{\"first_name\" : \"Alejandro\"}"</code></p><note>
145 /// <p>If you don't include any JSON input data, you still must include the two braces, for example: <code>"{}"</code></p>
146 /// </note>
147 /// <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
148 pub fn input(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
149 self.inner = self.inner.input(input.into());
150 self
151 }
152 /// <p>The string that contains the JSON input data for the execution, for example:</p>
153 /// <p><code>"{\"first_name\" : \"Alejandro\"}"</code></p><note>
154 /// <p>If you don't include any JSON input data, you still must include the two braces, for example: <code>"{}"</code></p>
155 /// </note>
156 /// <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
157 pub fn set_input(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
158 self.inner = self.inner.set_input(input);
159 self
160 }
161 /// <p>The string that contains the JSON input data for the execution, for example:</p>
162 /// <p><code>"{\"first_name\" : \"Alejandro\"}"</code></p><note>
163 /// <p>If you don't include any JSON input data, you still must include the two braces, for example: <code>"{}"</code></p>
164 /// </note>
165 /// <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
166 pub fn get_input(&self) -> &::std::option::Option<::std::string::String> {
167 self.inner.get_input()
168 }
169 /// <p>Passes the X-Ray trace header. The trace header can also be passed in the request payload.</p><note>
170 /// <p>For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.</p>
171 /// </note>
172 pub fn trace_header(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
173 self.inner = self.inner.trace_header(input.into());
174 self
175 }
176 /// <p>Passes the X-Ray trace header. The trace header can also be passed in the request payload.</p><note>
177 /// <p>For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.</p>
178 /// </note>
179 pub fn set_trace_header(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
180 self.inner = self.inner.set_trace_header(input);
181 self
182 }
183 /// <p>Passes the X-Ray trace header. The trace header can also be passed in the request payload.</p><note>
184 /// <p>For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.</p>
185 /// </note>
186 pub fn get_trace_header(&self) -> &::std::option::Option<::std::string::String> {
187 self.inner.get_trace_header()
188 }
189 /// <p>If your state machine definition is encrypted with a KMS key, callers must have <code>kms:Decrypt</code> permission to decrypt the definition. Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
190 pub fn included_data(mut self, input: crate::types::IncludedData) -> Self {
191 self.inner = self.inner.included_data(input);
192 self
193 }
194 /// <p>If your state machine definition is encrypted with a KMS key, callers must have <code>kms:Decrypt</code> permission to decrypt the definition. Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
195 pub fn set_included_data(mut self, input: ::std::option::Option<crate::types::IncludedData>) -> Self {
196 self.inner = self.inner.set_included_data(input);
197 self
198 }
199 /// <p>If your state machine definition is encrypted with a KMS key, callers must have <code>kms:Decrypt</code> permission to decrypt the definition. Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
200 pub fn get_included_data(&self) -> &::std::option::Option<crate::types::IncludedData> {
201 self.inner.get_included_data()
202 }
203}