aws-sdk-ssm 1.133.0

AWS SDK for Amazon Simple Systems Manager (SSM)
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
// 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 DescribeOpsItemsInput {
    /// <p>One or more filters to limit the response.</p>
    /// <ul>
    /// <li>
    /// <p>Key: CreatedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: LastModifiedBy</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: LastModifiedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: Priority</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Source</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: Status</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Title*</p>
    /// <p>Operations: Equals,Contains</p></li>
    /// <li>
    /// <p>Key: OperationalData**</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataKey</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataValue</p>
    /// <p>Operations: Equals, Contains</p></li>
    /// <li>
    /// <p>Key: OpsItemId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: ResourceId</p>
    /// <p>Operations: Contains</p></li>
    /// <li>
    /// <p>Key: AutomationId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: AccountId</p>
    /// <p>Operations: Equals</p></li>
    /// </ul>
    /// <p>*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.</p>
    /// <p>**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}</p>
    pub ops_item_filters: ::std::option::Option<::std::vec::Vec<crate::types::OpsItemFilter>>,
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub max_results: ::std::option::Option<i32>,
    /// <p>A token to start the list. Use this token to get the next set of results.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
}
impl DescribeOpsItemsInput {
    /// <p>One or more filters to limit the response.</p>
    /// <ul>
    /// <li>
    /// <p>Key: CreatedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: LastModifiedBy</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: LastModifiedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: Priority</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Source</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: Status</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Title*</p>
    /// <p>Operations: Equals,Contains</p></li>
    /// <li>
    /// <p>Key: OperationalData**</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataKey</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataValue</p>
    /// <p>Operations: Equals, Contains</p></li>
    /// <li>
    /// <p>Key: OpsItemId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: ResourceId</p>
    /// <p>Operations: Contains</p></li>
    /// <li>
    /// <p>Key: AutomationId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: AccountId</p>
    /// <p>Operations: Equals</p></li>
    /// </ul>
    /// <p>*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.</p>
    /// <p>**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}</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 `.ops_item_filters.is_none()`.
    pub fn ops_item_filters(&self) -> &[crate::types::OpsItemFilter] {
        self.ops_item_filters.as_deref().unwrap_or_default()
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
    /// <p>A token to start the list. Use this token to get the next set of results.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
}
static DESCRIBEOPSITEMSINPUT_MEMBER_OPS_ITEM_FILTERS_MEMBER: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts("com.amazonaws.ssm#OpsItemFilters$member", "com.amazonaws.ssm", "OpsItemFilters"),
    ::aws_smithy_schema::ShapeType::Structure,
    "member",
    0,
);
static DESCRIBEOPSITEMSINPUT_MEMBER_OPS_ITEM_FILTERS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeOpsItemsInput$OpsItemFilters",
        "com.amazonaws.ssm.synthetic",
        "DescribeOpsItemsInput",
    ),
    ::aws_smithy_schema::ShapeType::List,
    "OpsItemFilters",
    0,
)
.with_list_member(&DESCRIBEOPSITEMSINPUT_MEMBER_OPS_ITEM_FILTERS_MEMBER);
static DESCRIBEOPSITEMSINPUT_MEMBER_MAX_RESULTS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeOpsItemsInput$MaxResults",
        "com.amazonaws.ssm.synthetic",
        "DescribeOpsItemsInput",
    ),
    ::aws_smithy_schema::ShapeType::Integer,
    "MaxResults",
    1,
);
static DESCRIBEOPSITEMSINPUT_MEMBER_NEXT_TOKEN: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeOpsItemsInput$NextToken",
        "com.amazonaws.ssm.synthetic",
        "DescribeOpsItemsInput",
    ),
    ::aws_smithy_schema::ShapeType::String,
    "NextToken",
    2,
);
static DESCRIBEOPSITEMSINPUT_SCHEMA: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_struct(
    ::aws_smithy_schema::ShapeId::from_parts(
        "com.amazonaws.ssm.synthetic#DescribeOpsItemsInput",
        "com.amazonaws.ssm.synthetic",
        "DescribeOpsItemsInput",
    ),
    ::aws_smithy_schema::ShapeType::Structure,
    &[
        &DESCRIBEOPSITEMSINPUT_MEMBER_OPS_ITEM_FILTERS,
        &DESCRIBEOPSITEMSINPUT_MEMBER_MAX_RESULTS,
        &DESCRIBEOPSITEMSINPUT_MEMBER_NEXT_TOKEN,
    ],
)
.with_payload_hint(::aws_smithy_schema::PayloadHint::NoStructPayload)
.with_original_name("DescribeOpsItemsRequest");
impl DescribeOpsItemsInput {
    /// The schema for this shape.
    pub const SCHEMA: &'static ::aws_smithy_schema::Schema<'static> = &DESCRIBEOPSITEMSINPUT_SCHEMA;
}
impl ::aws_smithy_schema::serde::SerializableStruct for DescribeOpsItemsInput {
    fn schema(&self) -> &::aws_smithy_schema::Schema<'_> {
        Self::SCHEMA
    }

    #[allow(unused_variables, clippy::diverging_sub_expression)]
    fn serialize_members(
        &self,
        ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer,
    ) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
        if let Some(ref val) = self.ops_item_filters {
            ser.write_list(
                &DESCRIBEOPSITEMSINPUT_MEMBER_OPS_ITEM_FILTERS,
                &|ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer| {
                    for item in val {
                        ser.write_struct(crate::types::OpsItemFilter::SCHEMA, item)?;
                    }
                    Ok(())
                },
            )?;
        }
        if let Some(ref val) = self.max_results {
            ser.write_integer(&DESCRIBEOPSITEMSINPUT_MEMBER_MAX_RESULTS, *val)?;
        }
        if let Some(ref val) = self.next_token {
            ser.write_string(&DESCRIBEOPSITEMSINPUT_MEMBER_NEXT_TOKEN, val)?;
        }
        Ok(())
    }
}
impl crate::operation::describe_ops_items::builders::DescribeOpsItemsInputBuilder {
    #[allow(
        unused_variables,
        unreachable_code,
        clippy::single_match,
        clippy::match_single_binding,
        clippy::diverging_sub_expression
    )]
    pub(crate) fn deserialize_members(
        &mut self,
        deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
    ) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
        deserializer.read_struct(&DESCRIBEOPSITEMSINPUT_SCHEMA, &mut |member, deser| {
            match member.member_index() {
                Some(0) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.ops_item_filters = Some({
                            let mut container = Vec::new();
                            deser.read_list(member, &mut |deser| {
                                container.push(crate::types::OpsItemFilter::deserialize(deser)?);
                                Ok(())
                            })?;
                            container
                        });
                    }
                }
                Some(1) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.max_results = Some(deser.read_integer(member)?);
                    }
                }
                Some(2) => {
                    if deser.is_null() {
                        deser.read_null()?;
                    } else {
                        self.next_token = Some(deser.read_string(member)?);
                    }
                }
                _ => {}
            }
            Ok(())
        })
    }
}

impl DescribeOpsItemsInput {
    /// Deserializes this structure from a [`ShapeDeserializer`].
    pub fn deserialize(
        deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
    ) -> ::std::result::Result<Self, ::aws_smithy_schema::serde::SerdeError> {
        let mut builder = Self::builder();
        builder.deserialize_members(deserializer)?;
        builder.build().map_err(|e| aws_smithy_schema::serde::SerdeError::custom(e.to_string()))
    }
}
impl DescribeOpsItemsInput {
    /// Creates a new builder-style object to manufacture [`DescribeOpsItemsInput`](crate::operation::describe_ops_items::DescribeOpsItemsInput).
    pub fn builder() -> crate::operation::describe_ops_items::builders::DescribeOpsItemsInputBuilder {
        crate::operation::describe_ops_items::builders::DescribeOpsItemsInputBuilder::default()
    }
}

/// A builder for [`DescribeOpsItemsInput`](crate::operation::describe_ops_items::DescribeOpsItemsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeOpsItemsInputBuilder {
    pub(crate) ops_item_filters: ::std::option::Option<::std::vec::Vec<crate::types::OpsItemFilter>>,
    pub(crate) max_results: ::std::option::Option<i32>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
}
impl DescribeOpsItemsInputBuilder {
    /// Appends an item to `ops_item_filters`.
    ///
    /// To override the contents of this collection use [`set_ops_item_filters`](Self::set_ops_item_filters).
    ///
    /// <p>One or more filters to limit the response.</p>
    /// <ul>
    /// <li>
    /// <p>Key: CreatedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: LastModifiedBy</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: LastModifiedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: Priority</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Source</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: Status</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Title*</p>
    /// <p>Operations: Equals,Contains</p></li>
    /// <li>
    /// <p>Key: OperationalData**</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataKey</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataValue</p>
    /// <p>Operations: Equals, Contains</p></li>
    /// <li>
    /// <p>Key: OpsItemId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: ResourceId</p>
    /// <p>Operations: Contains</p></li>
    /// <li>
    /// <p>Key: AutomationId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: AccountId</p>
    /// <p>Operations: Equals</p></li>
    /// </ul>
    /// <p>*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.</p>
    /// <p>**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}</p>
    pub fn ops_item_filters(mut self, input: crate::types::OpsItemFilter) -> Self {
        let mut v = self.ops_item_filters.unwrap_or_default();
        v.push(input);
        self.ops_item_filters = ::std::option::Option::Some(v);
        self
    }
    /// <p>One or more filters to limit the response.</p>
    /// <ul>
    /// <li>
    /// <p>Key: CreatedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: LastModifiedBy</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: LastModifiedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: Priority</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Source</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: Status</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Title*</p>
    /// <p>Operations: Equals,Contains</p></li>
    /// <li>
    /// <p>Key: OperationalData**</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataKey</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataValue</p>
    /// <p>Operations: Equals, Contains</p></li>
    /// <li>
    /// <p>Key: OpsItemId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: ResourceId</p>
    /// <p>Operations: Contains</p></li>
    /// <li>
    /// <p>Key: AutomationId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: AccountId</p>
    /// <p>Operations: Equals</p></li>
    /// </ul>
    /// <p>*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.</p>
    /// <p>**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}</p>
    pub fn set_ops_item_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::OpsItemFilter>>) -> Self {
        self.ops_item_filters = input;
        self
    }
    /// <p>One or more filters to limit the response.</p>
    /// <ul>
    /// <li>
    /// <p>Key: CreatedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: LastModifiedBy</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: LastModifiedTime</p>
    /// <p>Operations: GreaterThan, LessThan</p></li>
    /// <li>
    /// <p>Key: Priority</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Source</p>
    /// <p>Operations: Contains, Equals</p></li>
    /// <li>
    /// <p>Key: Status</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: Title*</p>
    /// <p>Operations: Equals,Contains</p></li>
    /// <li>
    /// <p>Key: OperationalData**</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataKey</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: OperationalDataValue</p>
    /// <p>Operations: Equals, Contains</p></li>
    /// <li>
    /// <p>Key: OpsItemId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: ResourceId</p>
    /// <p>Operations: Contains</p></li>
    /// <li>
    /// <p>Key: AutomationId</p>
    /// <p>Operations: Equals</p></li>
    /// <li>
    /// <p>Key: AccountId</p>
    /// <p>Operations: Equals</p></li>
    /// </ul>
    /// <p>*The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.</p>
    /// <p>**If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {"key":"key_name","value":"a_value"}</p>
    pub fn get_ops_item_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::OpsItemFilter>> {
        &self.ops_item_filters
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// <p>A token to start the list. Use this token to get the next set of results.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.next_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A token to start the list. Use this token to get the next set of results.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>A token to start the list. Use this token to get the next set of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// Consumes the builder and constructs a [`DescribeOpsItemsInput`](crate::operation::describe_ops_items::DescribeOpsItemsInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::describe_ops_items::DescribeOpsItemsInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::describe_ops_items::DescribeOpsItemsInput {
            ops_item_filters: self.ops_item_filters,
            max_results: self.max_results,
            next_token: self.next_token,
        })
    }
}