Struct aws_sdk_quicksight::client::fluent_builders::CreateAccountSubscription

pub struct CreateAccountSubscription { /* private fields */ }

Fluent builder constructing a request to CreateAccountSubscription.

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region.

Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide.

If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails.

You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide.

You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.

Implementations

impl CreateAccountSubscription

pub async fn send(
    self
) -> Result<CreateAccountSubscriptionOutput, SdkError<CreateAccountSubscriptionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn edition(self, input: Edition) -> Self

The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

If you choose ENTERPRISE_AND_Q, the following parameters are required:

• FirstName

• LastName

• EmailAddress

• ContactNumber

pub fn set_edition(self, input: Option<Edition>) -> Self

The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q.

If you choose ENTERPRISE_AND_Q, the following parameters are required:

• FirstName

• LastName

• EmailAddress

• ContactNumber

pub fn authentication_method(self, input: AuthenticationMethodOption) -> Self

The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, and ACTIVE_DIRECTORY.

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

pub fn set_authentication_method(
    self,
    input: Option<AuthenticationMethodOption>
) -> Self

The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, and ACTIVE_DIRECTORY.

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.

pub fn aws_account_id(self, input: impl Into<String>) -> Self

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

pub fn set_aws_account_id(self, input: Option<String>) -> Self

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

pub fn account_name(self, input: impl Into<String>) -> Self

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 AccountName value after the Amazon QuickSight account is created.

pub fn set_account_name(self, input: Option<String>) -> Self

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 AccountName value after the Amazon QuickSight account is created.

pub fn notification_email(self, input: impl Into<String>) -> Self

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

pub fn set_notification_email(self, input: Option<String>) -> Self

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

pub fn active_directory_name(self, input: impl Into<String>) -> Self

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

pub fn set_active_directory_name(self, input: Option<String>) -> Self

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

pub fn realm(self, input: impl Into<String>) -> Self

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

pub fn set_realm(self, input: Option<String>) -> Self

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

pub fn directory_id(self, input: impl Into<String>) -> Self

The ID of the Active Directory that is associated with your Amazon QuickSight account.

pub fn set_directory_id(self, input: Option<String>) -> Self

The ID of the Active Directory that is associated with your Amazon QuickSight account.

pub fn admin_group(self, input: impl Into<String>) -> Self

Appends an item to AdminGroup.

To override the contents of this collection use set_admin_group.

The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

pub fn set_admin_group(self, input: Option<Vec<String>>) -> Self

The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

pub fn author_group(self, input: impl Into<String>) -> Self

Appends an item to AuthorGroup.

To override the contents of this collection use set_author_group.

The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

pub fn set_author_group(self, input: Option<Vec<String>>) -> Self

The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

pub fn reader_group(self, input: impl Into<String>) -> Self

Appends an item to ReaderGroup.

To override the contents of this collection use set_reader_group.

The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

pub fn set_reader_group(self, input: Option<Vec<String>>) -> Self

The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

pub fn first_name(self, input: impl Into<String>) -> Self

The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

pub fn set_first_name(self, input: Option<String>) -> Self

The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

pub fn last_name(self, input: impl Into<String>) -> Self

The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

pub fn set_last_name(self, input: Option<String>) -> Self

The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

pub fn email_address(self, input: impl Into<String>) -> Self

The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

pub fn set_email_address(self, input: Option<String>) -> Self

The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

pub fn contact_number(self, input: impl Into<String>) -> Self

A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

pub fn set_contact_number(self, input: Option<String>) -> Self

A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.

Trait Implementations

impl Clone for CreateAccountSubscription

fn clone(&self) -> CreateAccountSubscription

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateAccountSubscription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.