aws-sdk-appintegrations 1.117.0

AWS SDK for Amazon AppIntegrations Service
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
// 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 CreateApplicationInput {
    /// <p>The name of the application.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The namespace of the application.</p>
    pub namespace: ::std::option::Option<::std::string::String>,
    /// <p>The description of the application.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The configuration for where the application should be loaded from.</p>
    pub application_source_config: ::std::option::Option<crate::types::ApplicationSourceConfig>,
    /// <p>The events that the application subscribes.</p>
    #[deprecated(note = "Subscriptions has been replaced with Permissions")]
    pub subscriptions: ::std::option::Option<::std::vec::Vec<crate::types::Subscription>>,
    /// <p>The events that the application publishes.</p>
    #[deprecated(note = "Publications has been replaced with Permissions")]
    pub publications: ::std::option::Option<::std::vec::Vec<crate::types::Publication>>,
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    /// <p>The configuration of events or requests that the application has access to.</p>
    pub permissions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>Indicates whether the application is a service.</p>
    #[deprecated(note = "IsService has been deprecated in favor of ApplicationType", since = "2025-12-01")]
    pub is_service: ::std::option::Option<bool>,
    /// <p>The maximum time in milliseconds allowed to establish a connection with the workspace.</p>
    pub initialization_timeout: ::std::option::Option<i32>,
    /// <p>The configuration settings for the application.</p>
    pub application_config: ::std::option::Option<crate::types::ApplicationConfig>,
    /// <p>The iframe configuration for the application.</p>
    pub iframe_config: ::std::option::Option<crate::types::IframeConfig>,
    /// <p>The type of application.</p>
    pub application_type: ::std::option::Option<crate::types::ApplicationType>,
    /// <p>The authentication settings that Connect Customer uses when calling the external application.</p>
    pub auth_config: ::std::option::Option<crate::types::AuthConfig>,
}
impl CreateApplicationInput {
    /// <p>The name of the application.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The namespace of the application.</p>
    pub fn namespace(&self) -> ::std::option::Option<&str> {
        self.namespace.as_deref()
    }
    /// <p>The description of the application.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The configuration for where the application should be loaded from.</p>
    pub fn application_source_config(&self) -> ::std::option::Option<&crate::types::ApplicationSourceConfig> {
        self.application_source_config.as_ref()
    }
    /// <p>The events that the application subscribes.</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 `.subscriptions.is_none()`.
    #[deprecated(note = "Subscriptions has been replaced with Permissions")]
    pub fn subscriptions(&self) -> &[crate::types::Subscription] {
        self.subscriptions.as_deref().unwrap_or_default()
    }
    /// <p>The events that the application publishes.</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 `.publications.is_none()`.
    #[deprecated(note = "Publications has been replaced with Permissions")]
    pub fn publications(&self) -> &[crate::types::Publication] {
        self.publications.as_deref().unwrap_or_default()
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
    /// <p>The configuration of events or requests that the application has access to.</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 `.permissions.is_none()`.
    pub fn permissions(&self) -> &[::std::string::String] {
        self.permissions.as_deref().unwrap_or_default()
    }
    /// <p>Indicates whether the application is a service.</p>
    #[deprecated(note = "IsService has been deprecated in favor of ApplicationType", since = "2025-12-01")]
    pub fn is_service(&self) -> ::std::option::Option<bool> {
        self.is_service
    }
    /// <p>The maximum time in milliseconds allowed to establish a connection with the workspace.</p>
    pub fn initialization_timeout(&self) -> ::std::option::Option<i32> {
        self.initialization_timeout
    }
    /// <p>The configuration settings for the application.</p>
    pub fn application_config(&self) -> ::std::option::Option<&crate::types::ApplicationConfig> {
        self.application_config.as_ref()
    }
    /// <p>The iframe configuration for the application.</p>
    pub fn iframe_config(&self) -> ::std::option::Option<&crate::types::IframeConfig> {
        self.iframe_config.as_ref()
    }
    /// <p>The type of application.</p>
    pub fn application_type(&self) -> ::std::option::Option<&crate::types::ApplicationType> {
        self.application_type.as_ref()
    }
    /// <p>The authentication settings that Connect Customer uses when calling the external application.</p>
    pub fn auth_config(&self) -> ::std::option::Option<&crate::types::AuthConfig> {
        self.auth_config.as_ref()
    }
}
impl CreateApplicationInput {
    /// Creates a new builder-style object to manufacture [`CreateApplicationInput`](crate::operation::create_application::CreateApplicationInput).
    pub fn builder() -> crate::operation::create_application::builders::CreateApplicationInputBuilder {
        crate::operation::create_application::builders::CreateApplicationInputBuilder::default()
    }
}

/// A builder for [`CreateApplicationInput`](crate::operation::create_application::CreateApplicationInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateApplicationInputBuilder {
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) namespace: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) application_source_config: ::std::option::Option<crate::types::ApplicationSourceConfig>,
    pub(crate) subscriptions: ::std::option::Option<::std::vec::Vec<crate::types::Subscription>>,
    pub(crate) publications: ::std::option::Option<::std::vec::Vec<crate::types::Publication>>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    pub(crate) permissions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) is_service: ::std::option::Option<bool>,
    pub(crate) initialization_timeout: ::std::option::Option<i32>,
    pub(crate) application_config: ::std::option::Option<crate::types::ApplicationConfig>,
    pub(crate) iframe_config: ::std::option::Option<crate::types::IframeConfig>,
    pub(crate) application_type: ::std::option::Option<crate::types::ApplicationType>,
    pub(crate) auth_config: ::std::option::Option<crate::types::AuthConfig>,
}
impl CreateApplicationInputBuilder {
    /// <p>The name of the application.</p>
    /// This field is required.
    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 application.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the application.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The namespace of the application.</p>
    /// This field is required.
    pub fn namespace(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.namespace = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The namespace of the application.</p>
    pub fn set_namespace(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.namespace = input;
        self
    }
    /// <p>The namespace of the application.</p>
    pub fn get_namespace(&self) -> &::std::option::Option<::std::string::String> {
        &self.namespace
    }
    /// <p>The description of the application.</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>The description of the application.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>The description of the application.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// <p>The configuration for where the application should be loaded from.</p>
    /// This field is required.
    pub fn application_source_config(mut self, input: crate::types::ApplicationSourceConfig) -> Self {
        self.application_source_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>The configuration for where the application should be loaded from.</p>
    pub fn set_application_source_config(mut self, input: ::std::option::Option<crate::types::ApplicationSourceConfig>) -> Self {
        self.application_source_config = input;
        self
    }
    /// <p>The configuration for where the application should be loaded from.</p>
    pub fn get_application_source_config(&self) -> &::std::option::Option<crate::types::ApplicationSourceConfig> {
        &self.application_source_config
    }
    /// Appends an item to `subscriptions`.
    ///
    /// To override the contents of this collection use [`set_subscriptions`](Self::set_subscriptions).
    ///
    /// <p>The events that the application subscribes.</p>
    #[deprecated(note = "Subscriptions has been replaced with Permissions")]
    pub fn subscriptions(mut self, input: crate::types::Subscription) -> Self {
        let mut v = self.subscriptions.unwrap_or_default();
        v.push(input);
        self.subscriptions = ::std::option::Option::Some(v);
        self
    }
    /// <p>The events that the application subscribes.</p>
    #[deprecated(note = "Subscriptions has been replaced with Permissions")]
    pub fn set_subscriptions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Subscription>>) -> Self {
        self.subscriptions = input;
        self
    }
    /// <p>The events that the application subscribes.</p>
    #[deprecated(note = "Subscriptions has been replaced with Permissions")]
    pub fn get_subscriptions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Subscription>> {
        &self.subscriptions
    }
    /// Appends an item to `publications`.
    ///
    /// To override the contents of this collection use [`set_publications`](Self::set_publications).
    ///
    /// <p>The events that the application publishes.</p>
    #[deprecated(note = "Publications has been replaced with Permissions")]
    pub fn publications(mut self, input: crate::types::Publication) -> Self {
        let mut v = self.publications.unwrap_or_default();
        v.push(input);
        self.publications = ::std::option::Option::Some(v);
        self
    }
    /// <p>The events that the application publishes.</p>
    #[deprecated(note = "Publications has been replaced with Permissions")]
    pub fn set_publications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Publication>>) -> Self {
        self.publications = input;
        self
    }
    /// <p>The events that the application publishes.</p>
    #[deprecated(note = "Publications has been replaced with Permissions")]
    pub fn get_publications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Publication>> {
        &self.publications
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.tags.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.tags = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// Appends an item to `permissions`.
    ///
    /// To override the contents of this collection use [`set_permissions`](Self::set_permissions).
    ///
    /// <p>The configuration of events or requests that the application has access to.</p>
    pub fn permissions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.permissions.unwrap_or_default();
        v.push(input.into());
        self.permissions = ::std::option::Option::Some(v);
        self
    }
    /// <p>The configuration of events or requests that the application has access to.</p>
    pub fn set_permissions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.permissions = input;
        self
    }
    /// <p>The configuration of events or requests that the application has access to.</p>
    pub fn get_permissions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.permissions
    }
    /// <p>Indicates whether the application is a service.</p>
    #[deprecated(note = "IsService has been deprecated in favor of ApplicationType", since = "2025-12-01")]
    pub fn is_service(mut self, input: bool) -> Self {
        self.is_service = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates whether the application is a service.</p>
    #[deprecated(note = "IsService has been deprecated in favor of ApplicationType", since = "2025-12-01")]
    pub fn set_is_service(mut self, input: ::std::option::Option<bool>) -> Self {
        self.is_service = input;
        self
    }
    /// <p>Indicates whether the application is a service.</p>
    #[deprecated(note = "IsService has been deprecated in favor of ApplicationType", since = "2025-12-01")]
    pub fn get_is_service(&self) -> &::std::option::Option<bool> {
        &self.is_service
    }
    /// <p>The maximum time in milliseconds allowed to establish a connection with the workspace.</p>
    pub fn initialization_timeout(mut self, input: i32) -> Self {
        self.initialization_timeout = ::std::option::Option::Some(input);
        self
    }
    /// <p>The maximum time in milliseconds allowed to establish a connection with the workspace.</p>
    pub fn set_initialization_timeout(mut self, input: ::std::option::Option<i32>) -> Self {
        self.initialization_timeout = input;
        self
    }
    /// <p>The maximum time in milliseconds allowed to establish a connection with the workspace.</p>
    pub fn get_initialization_timeout(&self) -> &::std::option::Option<i32> {
        &self.initialization_timeout
    }
    /// <p>The configuration settings for the application.</p>
    pub fn application_config(mut self, input: crate::types::ApplicationConfig) -> Self {
        self.application_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>The configuration settings for the application.</p>
    pub fn set_application_config(mut self, input: ::std::option::Option<crate::types::ApplicationConfig>) -> Self {
        self.application_config = input;
        self
    }
    /// <p>The configuration settings for the application.</p>
    pub fn get_application_config(&self) -> &::std::option::Option<crate::types::ApplicationConfig> {
        &self.application_config
    }
    /// <p>The iframe configuration for the application.</p>
    pub fn iframe_config(mut self, input: crate::types::IframeConfig) -> Self {
        self.iframe_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>The iframe configuration for the application.</p>
    pub fn set_iframe_config(mut self, input: ::std::option::Option<crate::types::IframeConfig>) -> Self {
        self.iframe_config = input;
        self
    }
    /// <p>The iframe configuration for the application.</p>
    pub fn get_iframe_config(&self) -> &::std::option::Option<crate::types::IframeConfig> {
        &self.iframe_config
    }
    /// <p>The type of application.</p>
    pub fn application_type(mut self, input: crate::types::ApplicationType) -> Self {
        self.application_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of application.</p>
    pub fn set_application_type(mut self, input: ::std::option::Option<crate::types::ApplicationType>) -> Self {
        self.application_type = input;
        self
    }
    /// <p>The type of application.</p>
    pub fn get_application_type(&self) -> &::std::option::Option<crate::types::ApplicationType> {
        &self.application_type
    }
    /// <p>The authentication settings that Connect Customer uses when calling the external application.</p>
    pub fn auth_config(mut self, input: crate::types::AuthConfig) -> Self {
        self.auth_config = ::std::option::Option::Some(input);
        self
    }
    /// <p>The authentication settings that Connect Customer uses when calling the external application.</p>
    pub fn set_auth_config(mut self, input: ::std::option::Option<crate::types::AuthConfig>) -> Self {
        self.auth_config = input;
        self
    }
    /// <p>The authentication settings that Connect Customer uses when calling the external application.</p>
    pub fn get_auth_config(&self) -> &::std::option::Option<crate::types::AuthConfig> {
        &self.auth_config
    }
    /// Consumes the builder and constructs a [`CreateApplicationInput`](crate::operation::create_application::CreateApplicationInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_application::CreateApplicationInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_application::CreateApplicationInput {
            name: self.name,
            namespace: self.namespace,
            description: self.description,
            application_source_config: self.application_source_config,
            subscriptions: self.subscriptions,
            publications: self.publications,
            client_token: self.client_token,
            tags: self.tags,
            permissions: self.permissions,
            is_service: self.is_service,
            initialization_timeout: self.initialization_timeout,
            application_config: self.application_config,
            iframe_config: self.iframe_config,
            application_type: self.application_type,
            auth_config: self.auth_config,
        })
    }
}