1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_campaign::_create_campaign_output::CreateCampaignOutputBuilder;
pub use crate::operation::create_campaign::_create_campaign_input::CreateCampaignInputBuilder;
impl CreateCampaignInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::create_campaign::CreateCampaignOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_campaign::CreateCampaignError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.create_campaign();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `CreateCampaign`.
///
/// <p>Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles. </p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html">Collect and transfer data with campaigns</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateCampaignFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::create_campaign::builders::CreateCampaignInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::create_campaign::CreateCampaignOutput,
crate::operation::create_campaign::CreateCampaignError,
> for CreateCampaignFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::create_campaign::CreateCampaignOutput,
crate::operation::create_campaign::CreateCampaignError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl CreateCampaignFluentBuilder {
/// Creates a new `CreateCampaign`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the CreateCampaign as a reference.
pub fn as_input(&self) -> &crate::operation::create_campaign::builders::CreateCampaignInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::create_campaign::CreateCampaignOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::create_campaign::CreateCampaignError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::create_campaign::CreateCampaign::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::create_campaign::CreateCampaign::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::create_campaign::CreateCampaignOutput,
crate::operation::create_campaign::CreateCampaignError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p> The name of the campaign to create. </p>
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.name(input.into());
self
}
/// <p> The name of the campaign to create. </p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_name(input);
self
}
/// <p> The name of the campaign to create. </p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_name()
}
/// <p>An optional description of the campaign to help identify its purpose.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.description(input.into());
self
}
/// <p>An optional description of the campaign to help identify its purpose.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_description(input);
self
}
/// <p>An optional description of the campaign to help identify its purpose.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_description()
}
/// <p>(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign. </p>
pub fn signal_catalog_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.signal_catalog_arn(input.into());
self
}
/// <p>(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign. </p>
pub fn set_signal_catalog_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_signal_catalog_arn(input);
self
}
/// <p>(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign. </p>
pub fn get_signal_catalog_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_signal_catalog_arn()
}
/// <p> The ARN of the vehicle or fleet to deploy a campaign to. </p>
pub fn target_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.target_arn(input.into());
self
}
/// <p> The ARN of the vehicle or fleet to deploy a campaign to. </p>
pub fn set_target_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_target_arn(input);
self
}
/// <p> The ARN of the vehicle or fleet to deploy a campaign to. </p>
pub fn get_target_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_target_arn()
}
/// <p>(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, <code>0</code> is used.</p>
/// <p>Default: <code>0</code> </p>
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.start_time(input);
self
}
/// <p>(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, <code>0</code> is used.</p>
/// <p>Default: <code>0</code> </p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_start_time(input);
self
}
/// <p>(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, <code>0</code> is used.</p>
/// <p>Default: <code>0</code> </p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_start_time()
}
/// <p> (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires. </p>
/// <p>Default: 253402214400 (December 31, 9999, 00:00:00 UTC)</p>
pub fn expiry_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.inner = self.inner.expiry_time(input);
self
}
/// <p> (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires. </p>
/// <p>Default: 253402214400 (December 31, 9999, 00:00:00 UTC)</p>
pub fn set_expiry_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.inner = self.inner.set_expiry_time(input);
self
}
/// <p> (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires. </p>
/// <p>Default: 253402214400 (December 31, 9999, 00:00:00 UTC)</p>
pub fn get_expiry_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
self.inner.get_expiry_time()
}
/// <p> (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, <code>0</code> is used.</p>
/// <p>Default: <code>0</code> </p>
pub fn post_trigger_collection_duration(mut self, input: i64) -> Self {
self.inner = self.inner.post_trigger_collection_duration(input);
self
}
/// <p> (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, <code>0</code> is used.</p>
/// <p>Default: <code>0</code> </p>
pub fn set_post_trigger_collection_duration(mut self, input: ::std::option::Option<i64>) -> Self {
self.inner = self.inner.set_post_trigger_collection_duration(input);
self
}
/// <p> (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, <code>0</code> is used.</p>
/// <p>Default: <code>0</code> </p>
pub fn get_post_trigger_collection_duration(&self) -> &::std::option::Option<i64> {
self.inner.get_post_trigger_collection_duration()
}
/// <p> (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use <code>SEND_ACTIVE_DTCS</code>. If it's not specified, <code>OFF</code> is used.</p>
/// <p>Default: <code>OFF</code> </p>
pub fn diagnostics_mode(mut self, input: crate::types::DiagnosticsMode) -> Self {
self.inner = self.inner.diagnostics_mode(input);
self
}
/// <p> (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use <code>SEND_ACTIVE_DTCS</code>. If it's not specified, <code>OFF</code> is used.</p>
/// <p>Default: <code>OFF</code> </p>
pub fn set_diagnostics_mode(mut self, input: ::std::option::Option<crate::types::DiagnosticsMode>) -> Self {
self.inner = self.inner.set_diagnostics_mode(input);
self
}
/// <p> (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use <code>SEND_ACTIVE_DTCS</code>. If it's not specified, <code>OFF</code> is used.</p>
/// <p>Default: <code>OFF</code> </p>
pub fn get_diagnostics_mode(&self) -> &::std::option::Option<crate::types::DiagnosticsMode> {
self.inner.get_diagnostics_mode()
}
/// <p>(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use <code>TO_DISK</code>. If it's not specified, <code>OFF</code> is used.</p>
/// <p>Default: <code>OFF</code> </p>
pub fn spooling_mode(mut self, input: crate::types::SpoolingMode) -> Self {
self.inner = self.inner.spooling_mode(input);
self
}
/// <p>(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use <code>TO_DISK</code>. If it's not specified, <code>OFF</code> is used.</p>
/// <p>Default: <code>OFF</code> </p>
pub fn set_spooling_mode(mut self, input: ::std::option::Option<crate::types::SpoolingMode>) -> Self {
self.inner = self.inner.set_spooling_mode(input);
self
}
/// <p>(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use <code>TO_DISK</code>. If it's not specified, <code>OFF</code> is used.</p>
/// <p>Default: <code>OFF</code> </p>
pub fn get_spooling_mode(&self) -> &::std::option::Option<crate::types::SpoolingMode> {
self.inner.get_spooling_mode()
}
/// <p> (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use <code>OFF</code>. If it's not specified, <code>SNAPPY</code> is used. </p>
/// <p>Default: <code>SNAPPY</code> </p>
pub fn compression(mut self, input: crate::types::Compression) -> Self {
self.inner = self.inner.compression(input);
self
}
/// <p> (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use <code>OFF</code>. If it's not specified, <code>SNAPPY</code> is used. </p>
/// <p>Default: <code>SNAPPY</code> </p>
pub fn set_compression(mut self, input: ::std::option::Option<crate::types::Compression>) -> Self {
self.inner = self.inner.set_compression(input);
self
}
/// <p> (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use <code>OFF</code>. If it's not specified, <code>SNAPPY</code> is used. </p>
/// <p>Default: <code>SNAPPY</code> </p>
pub fn get_compression(&self) -> &::std::option::Option<crate::types::Compression> {
self.inner.get_compression()
}
/// <p>(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, <code>0</code> is used. </p>
/// <p>Default: <code>0</code> </p>
pub fn priority(mut self, input: i32) -> Self {
self.inner = self.inner.priority(input);
self
}
/// <p>(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, <code>0</code> is used. </p>
/// <p>Default: <code>0</code> </p>
pub fn set_priority(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_priority(input);
self
}
/// <p>(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, <code>0</code> is used. </p>
/// <p>Default: <code>0</code> </p>
pub fn get_priority(&self) -> &::std::option::Option<i32> {
self.inner.get_priority()
}
/// Appends an item to `signalsToCollect`.
///
/// To override the contents of this collection use [`set_signals_to_collect`](Self::set_signals_to_collect).
///
/// <p>(Optional) A list of information about signals to collect. </p>
pub fn signals_to_collect(mut self, input: crate::types::SignalInformation) -> Self {
self.inner = self.inner.signals_to_collect(input);
self
}
/// <p>(Optional) A list of information about signals to collect. </p>
pub fn set_signals_to_collect(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SignalInformation>>) -> Self {
self.inner = self.inner.set_signals_to_collect(input);
self
}
/// <p>(Optional) A list of information about signals to collect. </p>
pub fn get_signals_to_collect(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SignalInformation>> {
self.inner.get_signals_to_collect()
}
/// <p> The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.</p>
pub fn collection_scheme(mut self, input: crate::types::CollectionScheme) -> Self {
self.inner = self.inner.collection_scheme(input);
self
}
/// <p> The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.</p>
pub fn set_collection_scheme(mut self, input: ::std::option::Option<crate::types::CollectionScheme>) -> Self {
self.inner = self.inner.set_collection_scheme(input);
self
}
/// <p> The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.</p>
pub fn get_collection_scheme(&self) -> &::std::option::Option<crate::types::CollectionScheme> {
self.inner.get_collection_scheme()
}
/// Appends an item to `dataExtraDimensions`.
///
/// To override the contents of this collection use [`set_data_extra_dimensions`](Self::set_data_extra_dimensions).
///
/// <p> (Optional) A list of vehicle attributes to associate with a campaign. </p>
/// <p>Enrich the data with specified vehicle attributes. For example, add <code>make</code> and <code>model</code> to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against <code>make</code> and <code>model</code>.</p>
/// <p>Default: An empty array</p>
pub fn data_extra_dimensions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.data_extra_dimensions(input.into());
self
}
/// <p> (Optional) A list of vehicle attributes to associate with a campaign. </p>
/// <p>Enrich the data with specified vehicle attributes. For example, add <code>make</code> and <code>model</code> to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against <code>make</code> and <code>model</code>.</p>
/// <p>Default: An empty array</p>
pub fn set_data_extra_dimensions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_data_extra_dimensions(input);
self
}
/// <p> (Optional) A list of vehicle attributes to associate with a campaign. </p>
/// <p>Enrich the data with specified vehicle attributes. For example, add <code>make</code> and <code>model</code> to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against <code>make</code> and <code>model</code>.</p>
/// <p>Default: An empty array</p>
pub fn get_data_extra_dimensions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_data_extra_dimensions()
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Metadata that can be used to manage the campaign.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
self.inner = self.inner.tags(input);
self
}
/// <p>Metadata that can be used to manage the campaign.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.inner = self.inner.set_tags(input);
self
}
/// <p>Metadata that can be used to manage the campaign.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
self.inner.get_tags()
}
/// Appends an item to `dataDestinationConfigs`.
///
/// To override the contents of this collection use [`set_data_destination_configs`](Self::set_data_destination_configs).
///
/// <p>The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.</p>
/// <p>Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.</p>
/// <p>You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.</p>
pub fn data_destination_configs(mut self, input: crate::types::DataDestinationConfig) -> Self {
self.inner = self.inner.data_destination_configs(input);
self
}
/// <p>The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.</p>
/// <p>Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.</p>
/// <p>You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.</p>
pub fn set_data_destination_configs(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DataDestinationConfig>>) -> Self {
self.inner = self.inner.set_data_destination_configs(input);
self
}
/// <p>The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.</p>
/// <p>Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.</p>
/// <p>You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.</p>
pub fn get_data_destination_configs(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DataDestinationConfig>> {
self.inner.get_data_destination_configs()
}
}