aws_sdk_qbusiness/operation/create_subscription/
_create_subscription_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct CreateSubscriptionInput {
6    /// <p>The identifier of the Amazon Q Business application the subscription should be added to.</p>
7    pub application_id: ::std::option::Option<::std::string::String>,
8    /// <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
9    pub principal: ::std::option::Option<crate::types::SubscriptionPrincipal>,
10    /// <p>The type of Amazon Q Business subscription you want to create.</p>
11    pub r#type: ::std::option::Option<crate::types::SubscriptionType>,
12    /// <p>A token that you provide to identify the request to create a subscription for your Amazon Q Business application.</p>
13    pub client_token: ::std::option::Option<::std::string::String>,
14}
15impl CreateSubscriptionInput {
16    /// <p>The identifier of the Amazon Q Business application the subscription should be added to.</p>
17    pub fn application_id(&self) -> ::std::option::Option<&str> {
18        self.application_id.as_deref()
19    }
20    /// <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
21    pub fn principal(&self) -> ::std::option::Option<&crate::types::SubscriptionPrincipal> {
22        self.principal.as_ref()
23    }
24    /// <p>The type of Amazon Q Business subscription you want to create.</p>
25    pub fn r#type(&self) -> ::std::option::Option<&crate::types::SubscriptionType> {
26        self.r#type.as_ref()
27    }
28    /// <p>A token that you provide to identify the request to create a subscription for your Amazon Q Business application.</p>
29    pub fn client_token(&self) -> ::std::option::Option<&str> {
30        self.client_token.as_deref()
31    }
32}
33impl CreateSubscriptionInput {
34    /// Creates a new builder-style object to manufacture [`CreateSubscriptionInput`](crate::operation::create_subscription::CreateSubscriptionInput).
35    pub fn builder() -> crate::operation::create_subscription::builders::CreateSubscriptionInputBuilder {
36        crate::operation::create_subscription::builders::CreateSubscriptionInputBuilder::default()
37    }
38}
39
40/// A builder for [`CreateSubscriptionInput`](crate::operation::create_subscription::CreateSubscriptionInput).
41#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
42#[non_exhaustive]
43pub struct CreateSubscriptionInputBuilder {
44    pub(crate) application_id: ::std::option::Option<::std::string::String>,
45    pub(crate) principal: ::std::option::Option<crate::types::SubscriptionPrincipal>,
46    pub(crate) r#type: ::std::option::Option<crate::types::SubscriptionType>,
47    pub(crate) client_token: ::std::option::Option<::std::string::String>,
48}
49impl CreateSubscriptionInputBuilder {
50    /// <p>The identifier of the Amazon Q Business application the subscription should be added to.</p>
51    /// This field is required.
52    pub fn application_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
53        self.application_id = ::std::option::Option::Some(input.into());
54        self
55    }
56    /// <p>The identifier of the Amazon Q Business application the subscription should be added to.</p>
57    pub fn set_application_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
58        self.application_id = input;
59        self
60    }
61    /// <p>The identifier of the Amazon Q Business application the subscription should be added to.</p>
62    pub fn get_application_id(&self) -> &::std::option::Option<::std::string::String> {
63        &self.application_id
64    }
65    /// <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
66    /// This field is required.
67    pub fn principal(mut self, input: crate::types::SubscriptionPrincipal) -> Self {
68        self.principal = ::std::option::Option::Some(input);
69        self
70    }
71    /// <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
72    pub fn set_principal(mut self, input: ::std::option::Option<crate::types::SubscriptionPrincipal>) -> Self {
73        self.principal = input;
74        self
75    }
76    /// <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
77    pub fn get_principal(&self) -> &::std::option::Option<crate::types::SubscriptionPrincipal> {
78        &self.principal
79    }
80    /// <p>The type of Amazon Q Business subscription you want to create.</p>
81    /// This field is required.
82    pub fn r#type(mut self, input: crate::types::SubscriptionType) -> Self {
83        self.r#type = ::std::option::Option::Some(input);
84        self
85    }
86    /// <p>The type of Amazon Q Business subscription you want to create.</p>
87    pub fn set_type(mut self, input: ::std::option::Option<crate::types::SubscriptionType>) -> Self {
88        self.r#type = input;
89        self
90    }
91    /// <p>The type of Amazon Q Business subscription you want to create.</p>
92    pub fn get_type(&self) -> &::std::option::Option<crate::types::SubscriptionType> {
93        &self.r#type
94    }
95    /// <p>A token that you provide to identify the request to create a subscription for your Amazon Q Business application.</p>
96    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
97        self.client_token = ::std::option::Option::Some(input.into());
98        self
99    }
100    /// <p>A token that you provide to identify the request to create a subscription for your Amazon Q Business application.</p>
101    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
102        self.client_token = input;
103        self
104    }
105    /// <p>A token that you provide to identify the request to create a subscription for your Amazon Q Business application.</p>
106    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
107        &self.client_token
108    }
109    /// Consumes the builder and constructs a [`CreateSubscriptionInput`](crate::operation::create_subscription::CreateSubscriptionInput).
110    pub fn build(
111        self,
112    ) -> ::std::result::Result<crate::operation::create_subscription::CreateSubscriptionInput, ::aws_smithy_types::error::operation::BuildError> {
113        ::std::result::Result::Ok(crate::operation::create_subscription::CreateSubscriptionInput {
114            application_id: self.application_id,
115            principal: self.principal,
116            r#type: self.r#type,
117            client_token: self.client_token,
118        })
119    }
120}