aws_sdk_quicksight/client/

create_account_subscription.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateAccountSubscription`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`edition(Edition)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::edition) / [`set_edition(Option<Edition>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_edition):<br>required: **false**<br><p>The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from <code>ENTERPRISE</code> or <code>ENTERPRISE_AND_Q</code>.</p> <p>If you choose <code>ENTERPRISE_AND_Q</code>, the following parameters are required:</p> <ul>  <li>   <p><code>FirstName</code></p></li>  <li>   <p><code>LastName</code></p></li>  <li>   <p><code>EmailAddress</code></p></li>  <li>   <p><code>ContactNumber</code></p></li> </ul><br>
    ///   - [`authentication_method(AuthenticationMethodOption)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::authentication_method) / [`set_authentication_method(Option<AuthenticationMethodOption>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_authentication_method):<br>required: **true**<br><p>The method that you want to use to authenticate your Amazon QuickSight account.</p> <p>If you choose <code>ACTIVE_DIRECTORY</code>, provide an <code>ActiveDirectoryName</code> and an <code>AdminGroup</code> associated with your Active Directory.</p> <p>If you choose <code>IAM_IDENTITY_CENTER</code>, provide an <code>AdminGroup</code> associated with your IAM Identity Center account.</p><br>
    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.</p><br>
    ///   - [`account_name(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::account_name) / [`set_account_name(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_account_name):<br>required: **true**<br><p>The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change <code>AccountName</code> value after the Amazon QuickSight account is created.</p><br>
    ///   - [`notification_email(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::notification_email) / [`set_notification_email(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_notification_email):<br>required: **true**<br><p>The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.</p><br>
    ///   - [`active_directory_name(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::active_directory_name) / [`set_active_directory_name(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_active_directory_name):<br>required: **false**<br><p>The name of your Active Directory. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.</p><br>
    ///   - [`realm(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::realm) / [`set_realm(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_realm):<br>required: **false**<br><p>The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.</p><br>
    ///   - [`directory_id(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::directory_id) / [`set_directory_id(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_directory_id):<br>required: **false**<br><p>The ID of the Active Directory that is associated with your Amazon QuickSight account.</p><br>
    ///   - [`admin_group(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::admin_group) / [`set_admin_group(Option<Vec::<String>>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_admin_group):<br>required: **false**<br><p>The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the <code>AdminProGroup</code> field is required if <code>ACTIVE_DIRECTORY</code> or <code>IAM_IDENTITY_CENTER</code> is the selected authentication method of the new Amazon QuickSight account.</p> <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p><br>
    ///   - [`author_group(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::author_group) / [`set_author_group(Option<Vec::<String>>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_author_group):<br>required: **false**<br><p>The author group associated with your Active Directory or IAM Identity Center account.</p> <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p><br>
    ///   - [`reader_group(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::reader_group) / [`set_reader_group(Option<Vec::<String>>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_reader_group):<br>required: **false**<br><p>The reader group associated with your Active Directory or IAM Identity Center account.</p> <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p><br>
    ///   - [`admin_pro_group(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::admin_pro_group) / [`set_admin_pro_group(Option<Vec::<String>>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_admin_pro_group):<br>required: **false**<br><p>The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the <code>AdminGroup</code> field is required if <code>ACTIVE_DIRECTORY</code> or <code>IAM_IDENTITY_CENTER</code> is the selected authentication method of the new Amazon QuickSight account.</p> <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p><br>
    ///   - [`author_pro_group(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::author_pro_group) / [`set_author_pro_group(Option<Vec::<String>>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_author_pro_group):<br>required: **false**<br><p>The author pro group associated with your Active Directory or IAM Identity Center account.</p> <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p><br>
    ///   - [`reader_pro_group(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::reader_pro_group) / [`set_reader_pro_group(Option<Vec::<String>>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_reader_pro_group):<br>required: **false**<br><p>The reader pro group associated with your Active Directory or IAM Identity Center account.</p> <p>For more information about using IAM Identity Center in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html">Using IAM Identity Center with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p><br>
    ///   - [`first_name(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::first_name) / [`set_first_name(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_first_name):<br>required: **false**<br><p>The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.</p><br>
    ///   - [`last_name(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::last_name) / [`set_last_name(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_last_name):<br>required: **false**<br><p>The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.</p><br>
    ///   - [`email_address(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::email_address) / [`set_email_address(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_email_address):<br>required: **false**<br><p>The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.</p><br>
    ///   - [`contact_number(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::contact_number) / [`set_contact_number(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_contact_number):<br>required: **false**<br><p>A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.</p><br>
    ///   - [`iam_identity_center_instance_arn(impl Into<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::iam_identity_center_instance_arn) / [`set_iam_identity_center_instance_arn(Option<String>)`](crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::set_iam_identity_center_instance_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) for the IAM Identity Center instance.</p><br>
    /// - On success, responds with [`CreateAccountSubscriptionOutput`](crate::operation::create_account_subscription::CreateAccountSubscriptionOutput) with field(s):
    ///   - [`signup_response(Option<SignupResponse>)`](crate::operation::create_account_subscription::CreateAccountSubscriptionOutput::signup_response): <p>A <code>SignupResponse</code> object that returns information about a newly created Amazon QuickSight account.</p>
    ///   - [`status(i32)`](crate::operation::create_account_subscription::CreateAccountSubscriptionOutput::status): <p>The HTTP status of the request.</p>
    ///   - [`request_id(Option<String>)`](crate::operation::create_account_subscription::CreateAccountSubscriptionOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
    /// - On failure, responds with [`SdkError<CreateAccountSubscriptionError>`](crate::operation::create_account_subscription::CreateAccountSubscriptionError)
    pub fn create_account_subscription(&self) -> crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder {
        crate::operation::create_account_subscription::builders::CreateAccountSubscriptionFluentBuilder::new(self.handle.clone())
    }
}