aws-sdk-computeoptimizerautomation 1.3.0

AWS SDK for Compute Optimizer Automation
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
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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetAutomationRuleOutput {
    /// <p>The Amazon Resource Name (ARN) of the automation rule.</p>
    pub rule_arn: ::std::option::Option<::std::string::String>,
    /// <p>The unique identifier of the automation rule.</p>
    pub rule_id: ::std::option::Option<::std::string::String>,
    /// <p>The name of the automation rule.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>A description of the automation rule.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The type of automation rule.</p>
    pub rule_type: ::std::option::Option<crate::types::RuleType>,
    /// <p>The revision number of the automation rule.</p>
    pub rule_revision: ::std::option::Option<i64>,
    /// <p>The 12-digit Amazon Web Services account ID that owns this automation rule.</p>
    pub account_id: ::std::option::Option<::std::string::String>,
    /// <p>Configuration settings for organization-wide automation rules.</p>
    pub organization_configuration: ::std::option::Option<crate::types::OrganizationConfiguration>,
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule.</p>
    pub priority: ::std::option::Option<::std::string::String>,
    /// <p>List of recommended action types that this rule can execute.</p>
    pub recommended_action_types: ::std::option::Option<::std::vec::Vec<crate::types::RecommendedActionType>>,
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.</p>
    pub criteria: ::std::option::Option<crate::types::Criteria>,
    /// <p>Configuration for scheduling when automation rules should execute, including timing and execution windows.</p>
    pub schedule: ::std::option::Option<crate::types::Schedule>,
    /// <p>The current status of the automation rule (Active or Inactive).</p>
    pub status: ::std::option::Option<crate::types::RuleStatus>,
    /// <p>The tags associated with the automation rule.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    /// <p>The timestamp when the automation rule was created.</p>
    pub created_timestamp: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The timestamp when the automation rule was last updated.</p>
    pub last_updated_timestamp: ::std::option::Option<::aws_smithy_types::DateTime>,
    _request_id: Option<String>,
}
impl GetAutomationRuleOutput {
    /// <p>The Amazon Resource Name (ARN) of the automation rule.</p>
    pub fn rule_arn(&self) -> ::std::option::Option<&str> {
        self.rule_arn.as_deref()
    }
    /// <p>The unique identifier of the automation rule.</p>
    pub fn rule_id(&self) -> ::std::option::Option<&str> {
        self.rule_id.as_deref()
    }
    /// <p>The name of the automation rule.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>A description of the automation rule.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The type of automation rule.</p>
    pub fn rule_type(&self) -> ::std::option::Option<&crate::types::RuleType> {
        self.rule_type.as_ref()
    }
    /// <p>The revision number of the automation rule.</p>
    pub fn rule_revision(&self) -> ::std::option::Option<i64> {
        self.rule_revision
    }
    /// <p>The 12-digit Amazon Web Services account ID that owns this automation rule.</p>
    pub fn account_id(&self) -> ::std::option::Option<&str> {
        self.account_id.as_deref()
    }
    /// <p>Configuration settings for organization-wide automation rules.</p>
    pub fn organization_configuration(&self) -> ::std::option::Option<&crate::types::OrganizationConfiguration> {
        self.organization_configuration.as_ref()
    }
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule.</p>
    pub fn priority(&self) -> ::std::option::Option<&str> {
        self.priority.as_deref()
    }
    /// <p>List of recommended action types that this rule can execute.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.recommended_action_types.is_none()`.
    pub fn recommended_action_types(&self) -> &[crate::types::RecommendedActionType] {
        self.recommended_action_types.as_deref().unwrap_or_default()
    }
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.</p>
    pub fn criteria(&self) -> ::std::option::Option<&crate::types::Criteria> {
        self.criteria.as_ref()
    }
    /// <p>Configuration for scheduling when automation rules should execute, including timing and execution windows.</p>
    pub fn schedule(&self) -> ::std::option::Option<&crate::types::Schedule> {
        self.schedule.as_ref()
    }
    /// <p>The current status of the automation rule (Active or Inactive).</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::RuleStatus> {
        self.status.as_ref()
    }
    /// <p>The tags associated with the automation rule.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
    /// <p>The timestamp when the automation rule was created.</p>
    pub fn created_timestamp(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.created_timestamp.as_ref()
    }
    /// <p>The timestamp when the automation rule was last updated.</p>
    pub fn last_updated_timestamp(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.last_updated_timestamp.as_ref()
    }
}
impl ::aws_types::request_id::RequestId for GetAutomationRuleOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetAutomationRuleOutput {
    /// Creates a new builder-style object to manufacture [`GetAutomationRuleOutput`](crate::operation::get_automation_rule::GetAutomationRuleOutput).
    pub fn builder() -> crate::operation::get_automation_rule::builders::GetAutomationRuleOutputBuilder {
        crate::operation::get_automation_rule::builders::GetAutomationRuleOutputBuilder::default()
    }
}

/// A builder for [`GetAutomationRuleOutput`](crate::operation::get_automation_rule::GetAutomationRuleOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetAutomationRuleOutputBuilder {
    pub(crate) rule_arn: ::std::option::Option<::std::string::String>,
    pub(crate) rule_id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) rule_type: ::std::option::Option<crate::types::RuleType>,
    pub(crate) rule_revision: ::std::option::Option<i64>,
    pub(crate) account_id: ::std::option::Option<::std::string::String>,
    pub(crate) organization_configuration: ::std::option::Option<crate::types::OrganizationConfiguration>,
    pub(crate) priority: ::std::option::Option<::std::string::String>,
    pub(crate) recommended_action_types: ::std::option::Option<::std::vec::Vec<crate::types::RecommendedActionType>>,
    pub(crate) criteria: ::std::option::Option<crate::types::Criteria>,
    pub(crate) schedule: ::std::option::Option<crate::types::Schedule>,
    pub(crate) status: ::std::option::Option<crate::types::RuleStatus>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
    pub(crate) created_timestamp: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) last_updated_timestamp: ::std::option::Option<::aws_smithy_types::DateTime>,
    _request_id: Option<String>,
}
impl GetAutomationRuleOutputBuilder {
    /// <p>The Amazon Resource Name (ARN) of the automation rule.</p>
    pub fn rule_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.rule_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the automation rule.</p>
    pub fn set_rule_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.rule_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the automation rule.</p>
    pub fn get_rule_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.rule_arn
    }
    /// <p>The unique identifier of the automation rule.</p>
    pub fn rule_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.rule_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier of the automation rule.</p>
    pub fn set_rule_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.rule_id = input;
        self
    }
    /// <p>The unique identifier of the automation rule.</p>
    pub fn get_rule_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.rule_id
    }
    /// <p>The name of the automation rule.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the automation rule.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the automation rule.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>A description of the automation rule.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A description of the automation rule.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A description of the automation rule.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The type of automation rule.</p>
    pub fn rule_type(mut self, input: crate::types::RuleType) -> Self {
        self.rule_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of automation rule.</p>
    pub fn set_rule_type(mut self, input: ::std::option::Option<crate::types::RuleType>) -> Self {
        self.rule_type = input;
        self
    }
    /// <p>The type of automation rule.</p>
    pub fn get_rule_type(&self) -> &::std::option::Option<crate::types::RuleType> {
        &self.rule_type
    }
    /// <p>The revision number of the automation rule.</p>
    pub fn rule_revision(mut self, input: i64) -> Self {
        self.rule_revision = ::std::option::Option::Some(input);
        self
    }
    /// <p>The revision number of the automation rule.</p>
    pub fn set_rule_revision(mut self, input: ::std::option::Option<i64>) -> Self {
        self.rule_revision = input;
        self
    }
    /// <p>The revision number of the automation rule.</p>
    pub fn get_rule_revision(&self) -> &::std::option::Option<i64> {
        &self.rule_revision
    }
    /// <p>The 12-digit Amazon Web Services account ID that owns this automation rule.</p>
    pub fn account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.account_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The 12-digit Amazon Web Services account ID that owns this automation rule.</p>
    pub fn set_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.account_id = input;
        self
    }
    /// <p>The 12-digit Amazon Web Services account ID that owns this automation rule.</p>
    pub fn get_account_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.account_id
    }
    /// <p>Configuration settings for organization-wide automation rules.</p>
    pub fn organization_configuration(mut self, input: crate::types::OrganizationConfiguration) -> Self {
        self.organization_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>Configuration settings for organization-wide automation rules.</p>
    pub fn set_organization_configuration(mut self, input: ::std::option::Option<crate::types::OrganizationConfiguration>) -> Self {
        self.organization_configuration = input;
        self
    }
    /// <p>Configuration settings for organization-wide automation rules.</p>
    pub fn get_organization_configuration(&self) -> &::std::option::Option<crate::types::OrganizationConfiguration> {
        &self.organization_configuration
    }
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule.</p>
    pub fn priority(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.priority = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule.</p>
    pub fn set_priority(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.priority = input;
        self
    }
    /// <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule.</p>
    pub fn get_priority(&self) -> &::std::option::Option<::std::string::String> {
        &self.priority
    }
    /// Appends an item to `recommended_action_types`.
    ///
    /// To override the contents of this collection use [`set_recommended_action_types`](Self::set_recommended_action_types).
    ///
    /// <p>List of recommended action types that this rule can execute.</p>
    pub fn recommended_action_types(mut self, input: crate::types::RecommendedActionType) -> Self {
        let mut v = self.recommended_action_types.unwrap_or_default();
        v.push(input);
        self.recommended_action_types = ::std::option::Option::Some(v);
        self
    }
    /// <p>List of recommended action types that this rule can execute.</p>
    pub fn set_recommended_action_types(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::RecommendedActionType>>) -> Self {
        self.recommended_action_types = input;
        self
    }
    /// <p>List of recommended action types that this rule can execute.</p>
    pub fn get_recommended_action_types(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::RecommendedActionType>> {
        &self.recommended_action_types
    }
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.</p>
    pub fn criteria(mut self, input: crate::types::Criteria) -> Self {
        self.criteria = ::std::option::Option::Some(input);
        self
    }
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.</p>
    pub fn set_criteria(mut self, input: ::std::option::Option<crate::types::Criteria>) -> Self {
        self.criteria = input;
        self
    }
    /// <p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.</p>
    pub fn get_criteria(&self) -> &::std::option::Option<crate::types::Criteria> {
        &self.criteria
    }
    /// <p>Configuration for scheduling when automation rules should execute, including timing and execution windows.</p>
    pub fn schedule(mut self, input: crate::types::Schedule) -> Self {
        self.schedule = ::std::option::Option::Some(input);
        self
    }
    /// <p>Configuration for scheduling when automation rules should execute, including timing and execution windows.</p>
    pub fn set_schedule(mut self, input: ::std::option::Option<crate::types::Schedule>) -> Self {
        self.schedule = input;
        self
    }
    /// <p>Configuration for scheduling when automation rules should execute, including timing and execution windows.</p>
    pub fn get_schedule(&self) -> &::std::option::Option<crate::types::Schedule> {
        &self.schedule
    }
    /// <p>The current status of the automation rule (Active or Inactive).</p>
    pub fn status(mut self, input: crate::types::RuleStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current status of the automation rule (Active or Inactive).</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::RuleStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The current status of the automation rule (Active or Inactive).</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::RuleStatus> {
        &self.status
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The tags associated with the automation rule.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>The tags associated with the automation rule.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>The tags associated with the automation rule.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// <p>The timestamp when the automation rule was created.</p>
    pub fn created_timestamp(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.created_timestamp = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp when the automation rule was created.</p>
    pub fn set_created_timestamp(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.created_timestamp = input;
        self
    }
    /// <p>The timestamp when the automation rule was created.</p>
    pub fn get_created_timestamp(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.created_timestamp
    }
    /// <p>The timestamp when the automation rule was last updated.</p>
    pub fn last_updated_timestamp(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.last_updated_timestamp = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp when the automation rule was last updated.</p>
    pub fn set_last_updated_timestamp(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.last_updated_timestamp = input;
        self
    }
    /// <p>The timestamp when the automation rule was last updated.</p>
    pub fn get_last_updated_timestamp(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.last_updated_timestamp
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`GetAutomationRuleOutput`](crate::operation::get_automation_rule::GetAutomationRuleOutput).
    pub fn build(self) -> crate::operation::get_automation_rule::GetAutomationRuleOutput {
        crate::operation::get_automation_rule::GetAutomationRuleOutput {
            rule_arn: self.rule_arn,
            rule_id: self.rule_id,
            name: self.name,
            description: self.description,
            rule_type: self.rule_type,
            rule_revision: self.rule_revision,
            account_id: self.account_id,
            organization_configuration: self.organization_configuration,
            priority: self.priority,
            recommended_action_types: self.recommended_action_types,
            criteria: self.criteria,
            schedule: self.schedule,
            status: self.status,
            tags: self.tags,
            created_timestamp: self.created_timestamp,
            last_updated_timestamp: self.last_updated_timestamp,
            _request_id: self._request_id,
        }
    }
}