CreateAccountSubscriptionRequest

import type { CreateAccountSubscriptionRequest } from "https://aws-api.deno.dev/v0.4/services/quicksight.ts?docs=full";

interface CreateAccountSubscriptionRequest {

AccountName: string;

ActiveDirectoryName?: string | null;

AdminGroup?: string[] | null;

AuthenticationMethod: AuthenticationMethodOption;

AuthorGroup?: string[] | null;

AwsAccountId: string;

ContactNumber?: string | null;

DirectoryId?: string | null;

Edition: Edition;

EmailAddress?: string | null;

FirstName?: string | null;

LastName?: string | null;

NotificationEmail: string;

ReaderGroup?: string[] | null;

Realm?: string | null;

}

§Properties

AccountName: string

[src]

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.

ActiveDirectoryName?: string | null

[src]

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

AdminGroup?: string[] | null

[src]

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.

AuthenticationMethod: AuthenticationMethodOption

[src]

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.

AuthorGroup?: string[] | null

[src]

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.

AwsAccountId: string

[src]

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

ContactNumber?: string | null

[src]

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.

DirectoryId?: string | null

[src]

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

Edition: Edition

[src]

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
```

EmailAddress?: string | null

[src]

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.

FirstName?: string | null

[src]

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.

LastName?: string | null

[src]

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.

NotificationEmail: string

[src]

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

ReaderGroup?: string[] | null

[src]

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.

Realm?: string | null

[src]

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.