aws-sdk-iot 1.124.0

AWS SDK for AWS IoT
Documentation 
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

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::start_detect_mitigation_actions_task::_start_detect_mitigation_actions_task_input::StartDetectMitigationActionsTaskInputBuilder;

pub use crate::operation::start_detect_mitigation_actions_task::_start_detect_mitigation_actions_task_output::StartDetectMitigationActionsTaskOutputBuilder;

impl crate::operation::start_detect_mitigation_actions_task::builders::StartDetectMitigationActionsTaskInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.start_detect_mitigation_actions_task();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `StartDetectMitigationActionsTask`.
///
/// <note>
/// <p>The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. If you would like to use the detect feature, sign up prior to August 31, 2026. To learn about alternatives to IoT Device Defender detect, see IoT Device Defender detect feature availability change in the IoT Device Defender Developer Guide. There is no change to IoT Device Defender audit availability.</p>
/// </note>
/// <p>Starts a Device Defender ML Detect mitigation actions task.</p>
/// <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartDetectMitigationActionsTask</a> action.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct StartDetectMitigationActionsTaskFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::start_detect_mitigation_actions_task::builders::StartDetectMitigationActionsTaskInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskOutput,
        crate::operation::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskError,
    > for StartDetectMitigationActionsTaskFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskOutput,
            crate::operation::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl StartDetectMitigationActionsTaskFluentBuilder {
    /// Creates a new `StartDetectMitigationActionsTaskFluentBuilder`.
    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 StartDetectMitigationActionsTask as a reference.
    pub fn as_input(&self) -> &crate::operation::start_detect_mitigation_actions_task::builders::StartDetectMitigationActionsTaskInputBuilder {
        &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::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskError,
            ::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::start_detect_mitigation_actions_task::StartDetectMitigationActionsTask::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::start_detect_mitigation_actions_task::StartDetectMitigationActionsTask::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::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskOutput,
        crate::operation::start_detect_mitigation_actions_task::StartDetectMitigationActionsTaskError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The unique identifier of the task.</p>
    pub fn task_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.task_id(input.into());
        self
    }
    /// <p>The unique identifier of the task.</p>
    pub fn set_task_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_task_id(input);
        self
    }
    /// <p>The unique identifier of the task.</p>
    pub fn get_task_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_task_id()
    }
    /// <p>Specifies the ML Detect findings to which the mitigation actions are applied.</p>
    pub fn target(mut self, input: crate::types::DetectMitigationActionsTaskTarget) -> Self {
        self.inner = self.inner.target(input);
        self
    }
    /// <p>Specifies the ML Detect findings to which the mitigation actions are applied.</p>
    pub fn set_target(mut self, input: ::std::option::Option<crate::types::DetectMitigationActionsTaskTarget>) -> Self {
        self.inner = self.inner.set_target(input);
        self
    }
    /// <p>Specifies the ML Detect findings to which the mitigation actions are applied.</p>
    pub fn get_target(&self) -> &::std::option::Option<crate::types::DetectMitigationActionsTaskTarget> {
        self.inner.get_target()
    }
    ///
    /// Appends an item to `actions`.
    ///
    /// To override the contents of this collection use [`set_actions`](Self::set_actions).
    ///
    /// <p>The actions to be performed when a device has unexpected behavior.</p>
    pub fn actions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.actions(input.into());
        self
    }
    /// <p>The actions to be performed when a device has unexpected behavior.</p>
    pub fn set_actions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_actions(input);
        self
    }
    /// <p>The actions to be performed when a device has unexpected behavior.</p>
    pub fn get_actions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_actions()
    }
    /// <p>Specifies the time period of which violation events occurred between.</p>
    pub fn violation_event_occurrence_range(mut self, input: crate::types::ViolationEventOccurrenceRange) -> Self {
        self.inner = self.inner.violation_event_occurrence_range(input);
        self
    }
    /// <p>Specifies the time period of which violation events occurred between.</p>
    pub fn set_violation_event_occurrence_range(mut self, input: ::std::option::Option<crate::types::ViolationEventOccurrenceRange>) -> Self {
        self.inner = self.inner.set_violation_event_occurrence_range(input);
        self
    }
    /// <p>Specifies the time period of which violation events occurred between.</p>
    pub fn get_violation_event_occurrence_range(&self) -> &::std::option::Option<crate::types::ViolationEventOccurrenceRange> {
        self.inner.get_violation_event_occurrence_range()
    }
    /// <p>Specifies to list only active violations.</p>
    pub fn include_only_active_violations(mut self, input: bool) -> Self {
        self.inner = self.inner.include_only_active_violations(input);
        self
    }
    /// <p>Specifies to list only active violations.</p>
    pub fn set_include_only_active_violations(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_include_only_active_violations(input);
        self
    }
    /// <p>Specifies to list only active violations.</p>
    pub fn get_include_only_active_violations(&self) -> &::std::option::Option<bool> {
        self.inner.get_include_only_active_violations()
    }
    /// <p>Specifies to include suppressed alerts.</p>
    pub fn include_suppressed_alerts(mut self, input: bool) -> Self {
        self.inner = self.inner.include_suppressed_alerts(input);
        self
    }
    /// <p>Specifies to include suppressed alerts.</p>
    pub fn set_include_suppressed_alerts(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_include_suppressed_alerts(input);
        self
    }
    /// <p>Specifies to include suppressed alerts.</p>
    pub fn get_include_suppressed_alerts(&self) -> &::std::option::Option<bool> {
        self.inner.get_include_suppressed_alerts()
    }
    /// <p>Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.</p>
    pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.client_request_token(input.into());
        self
    }
    /// <p>Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.</p>
    pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_client_request_token(input);
        self
    }
    /// <p>Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.</p>
    pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_client_request_token()
    }
}