aws_sdk_qbusiness/client/create_subscription.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateSubscription`](crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`application_id(impl Into<String>)`](crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder::set_application_id):<br>required: **true**<br><p>The identifier of the Amazon Q Business application the subscription should be added to.</p><br>
7 /// - [`principal(SubscriptionPrincipal)`](crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder::principal) / [`set_principal(Option<SubscriptionPrincipal>)`](crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder::set_principal):<br>required: **true**<br><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><br>
8 /// - [`r#type(SubscriptionType)`](crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder::type) / [`set_type(Option<SubscriptionType>)`](crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder::set_type):<br>required: **true**<br><p>The type of Amazon Q Business subscription you want to create.</p><br>
9 /// - [`client_token(impl Into<String>)`](crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder::set_client_token):<br>required: **false**<br><p>A token that you provide to identify the request to create a subscription for your Amazon Q Business application.</p><br>
10 /// - On success, responds with [`CreateSubscriptionOutput`](crate::operation::create_subscription::CreateSubscriptionOutput) with field(s):
11 /// - [`subscription_id(Option<String>)`](crate::operation::create_subscription::CreateSubscriptionOutput::subscription_id): <p>The identifier of the Amazon Q Business subscription created.</p>
12 /// - [`subscription_arn(Option<String>)`](crate::operation::create_subscription::CreateSubscriptionOutput::subscription_arn): <p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription created.</p>
13 /// - [`current_subscription(Option<SubscriptionDetails>)`](crate::operation::create_subscription::CreateSubscriptionOutput::current_subscription): <p>The type of your current Amazon Q Business subscription.</p>
14 /// - [`next_subscription(Option<SubscriptionDetails>)`](crate::operation::create_subscription::CreateSubscriptionOutput::next_subscription): <p>The type of the Amazon Q Business subscription for the next month.</p>
15 /// - On failure, responds with [`SdkError<CreateSubscriptionError>`](crate::operation::create_subscription::CreateSubscriptionError)
16 pub fn create_subscription(&self) -> crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder {
17 crate::operation::create_subscription::builders::CreateSubscriptionFluentBuilder::new(self.handle.clone())
18 }
19}