Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.CreateAccountSubscription

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

Creating a Request

data CreateAccountSubscription Source #

See: newCreateAccountSubscription smart constructor.

Constructors

CreateAccountSubscription'

Fields

activeDirectoryName :: Maybe Text
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 :: Maybe [Text]
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.
authorGroup :: Maybe [Text]
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.
contactNumber :: Maybe Text
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 :: Maybe Text
The ID of the Active Directory that is associated with your Amazon QuickSight account.
emailAddress :: Maybe Text
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 :: Maybe Text
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 :: Maybe Text
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.
readerGroup :: Maybe [Text]
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 :: Maybe Text
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.
edition :: Edition
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
```
authenticationMethod :: AuthenticationMethodOption
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.
awsAccountId :: Text
The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
accountName :: Text
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.
notificationEmail :: Text
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

Instances

Instances details

ToJSON CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods toJSON :: CreateAccountSubscription -> Value # toEncoding :: CreateAccountSubscription -> Encoding # toJSONList :: [CreateAccountSubscription] -> Value # toEncodingList :: [CreateAccountSubscription] -> Encoding #
ToHeaders CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods toHeaders :: CreateAccountSubscription -> [Header] #
ToPath CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods toPath :: CreateAccountSubscription -> ByteString #
ToQuery CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods toQuery :: CreateAccountSubscription -> QueryString #
AWSRequest CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Associated Types type AWSResponse CreateAccountSubscription # Methods request :: (Service -> Service) -> CreateAccountSubscription -> Request CreateAccountSubscription # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAccountSubscription -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAccountSubscription))) #
Generic CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Associated Types type Rep CreateAccountSubscription :: Type -> Type # Methods from :: CreateAccountSubscription -> Rep CreateAccountSubscription x # to :: Rep CreateAccountSubscription x -> CreateAccountSubscription #
Read CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods readsPrec :: Int -> ReadS CreateAccountSubscription # readList :: ReadS [CreateAccountSubscription] # readPrec :: ReadPrec CreateAccountSubscription # readListPrec :: ReadPrec [CreateAccountSubscription] #
Show CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods showsPrec :: Int -> CreateAccountSubscription -> ShowS # show :: CreateAccountSubscription -> String # showList :: [CreateAccountSubscription] -> ShowS #
NFData CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods rnf :: CreateAccountSubscription -> () #
Eq CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods (==) :: CreateAccountSubscription -> CreateAccountSubscription -> Bool # (/=) :: CreateAccountSubscription -> CreateAccountSubscription -> Bool #
Hashable CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods hashWithSalt :: Int -> CreateAccountSubscription -> Int # hash :: CreateAccountSubscription -> Int #
type AWSResponse CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription type AWSResponse CreateAccountSubscription = CreateAccountSubscriptionResponse
type Rep CreateAccountSubscription Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription type Rep CreateAccountSubscription = D1 ('MetaData "CreateAccountSubscription" "Amazonka.QuickSight.CreateAccountSubscription" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateAccountSubscription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "activeDirectoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "adminGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "authorGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "contactNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "firstName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "lastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "readerGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "realm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "edition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Edition))) :: ((S1 ('MetaSel ('Just "authenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthenticationMethodOption) :: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "accountName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "notificationEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateAccountSubscription Source #

Arguments

:: Edition	`CreateAccountSubscription`
-> AuthenticationMethodOption	`$sel:authenticationMethod:CreateAccountSubscription'`
-> Text	`CreateAccountSubscription`
-> Text	`CreateAccountSubscription`
-> Text	`CreateAccountSubscription`
-> CreateAccountSubscription

Create a value of CreateAccountSubscription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activeDirectoryName:CreateAccountSubscription', createAccountSubscription_activeDirectoryName - The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

$sel:adminGroup:CreateAccountSubscription', createAccountSubscription_adminGroup - 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.

$sel:authorGroup:CreateAccountSubscription', createAccountSubscription_authorGroup - 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.

$sel:contactNumber:CreateAccountSubscription', createAccountSubscription_contactNumber - 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.

$sel:directoryId:CreateAccountSubscription', createAccountSubscription_directoryId - The ID of the Active Directory that is associated with your Amazon QuickSight account.

$sel:emailAddress:CreateAccountSubscription', createAccountSubscription_emailAddress - 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.

$sel:firstName:CreateAccountSubscription', createAccountSubscription_firstName - 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.

$sel:lastName:CreateAccountSubscription', createAccountSubscription_lastName - 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.

$sel:readerGroup:CreateAccountSubscription', createAccountSubscription_readerGroup - 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.

$sel:realm:CreateAccountSubscription', createAccountSubscription_realm - 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.

CreateAccountSubscription, createAccountSubscription_edition - 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
```

$sel:authenticationMethod:CreateAccountSubscription', createAccountSubscription_authenticationMethod - 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.

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

CreateAccountSubscription, createAccountSubscription_accountName - 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.

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

Request Lenses

createAccountSubscription_activeDirectoryName :: Lens' CreateAccountSubscription (Maybe Text) Source #

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

createAccountSubscription_adminGroup :: Lens' CreateAccountSubscription (Maybe [Text]) Source #

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.

createAccountSubscription_authorGroup :: Lens' CreateAccountSubscription (Maybe [Text]) Source #

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.

createAccountSubscription_contactNumber :: Lens' CreateAccountSubscription (Maybe Text) Source #

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.

createAccountSubscription_directoryId :: Lens' CreateAccountSubscription (Maybe Text) Source #

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

createAccountSubscription_emailAddress :: Lens' CreateAccountSubscription (Maybe Text) Source #

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.

createAccountSubscription_firstName :: Lens' CreateAccountSubscription (Maybe Text) Source #

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.

createAccountSubscription_lastName :: Lens' CreateAccountSubscription (Maybe Text) Source #

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.

createAccountSubscription_readerGroup :: Lens' CreateAccountSubscription (Maybe [Text]) Source #

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.

createAccountSubscription_realm :: Lens' CreateAccountSubscription (Maybe Text) Source #

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.

createAccountSubscription_edition :: Lens' CreateAccountSubscription Edition Source #

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

createAccountSubscription_authenticationMethod :: Lens' CreateAccountSubscription AuthenticationMethodOption Source #

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.

createAccountSubscription_awsAccountId :: Lens' CreateAccountSubscription Text Source #

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

createAccountSubscription_accountName :: Lens' CreateAccountSubscription Text Source #

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.

createAccountSubscription_notificationEmail :: Lens' CreateAccountSubscription Text Source #

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

Destructuring the Response

data CreateAccountSubscriptionResponse Source #

See: newCreateAccountSubscriptionResponse smart constructor.

Constructors

CreateAccountSubscriptionResponse'
Fields requestId :: Maybe Text The Amazon Web Services request ID for this operation. signupResponse :: Maybe SignupResponse A `SignupResponse` object that returns information about a newly created Amazon QuickSight account. status :: Int The HTTP status of the request.

Instances

Instances details

Generic CreateAccountSubscriptionResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Associated Types type Rep CreateAccountSubscriptionResponse :: Type -> Type # Methods from :: CreateAccountSubscriptionResponse -> Rep CreateAccountSubscriptionResponse x # to :: Rep CreateAccountSubscriptionResponse x -> CreateAccountSubscriptionResponse #
Read CreateAccountSubscriptionResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods readsPrec :: Int -> ReadS CreateAccountSubscriptionResponse # readList :: ReadS [CreateAccountSubscriptionResponse] # readPrec :: ReadPrec CreateAccountSubscriptionResponse # readListPrec :: ReadPrec [CreateAccountSubscriptionResponse] #
Show CreateAccountSubscriptionResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods showsPrec :: Int -> CreateAccountSubscriptionResponse -> ShowS # show :: CreateAccountSubscriptionResponse -> String # showList :: [CreateAccountSubscriptionResponse] -> ShowS #
NFData CreateAccountSubscriptionResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods rnf :: CreateAccountSubscriptionResponse -> () #
Eq CreateAccountSubscriptionResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription Methods (==) :: CreateAccountSubscriptionResponse -> CreateAccountSubscriptionResponse -> Bool # (/=) :: CreateAccountSubscriptionResponse -> CreateAccountSubscriptionResponse -> Bool #
type Rep CreateAccountSubscriptionResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateAccountSubscription type Rep CreateAccountSubscriptionResponse = D1 ('MetaData "CreateAccountSubscriptionResponse" "Amazonka.QuickSight.CreateAccountSubscription" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateAccountSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "signupResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SignupResponse)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateAccountSubscriptionResponse Source #

Arguments

:: Int	`CreateAccountSubscriptionResponse`
-> CreateAccountSubscriptionResponse

Create a value of CreateAccountSubscriptionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:CreateAccountSubscriptionResponse', createAccountSubscriptionResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:signupResponse:CreateAccountSubscriptionResponse', createAccountSubscriptionResponse_signupResponse - A SignupResponse object that returns information about a newly created Amazon QuickSight account.

CreateAccountSubscriptionResponse, createAccountSubscriptionResponse_status - The HTTP status of the request.

Response Lenses

createAccountSubscriptionResponse_requestId :: Lens' CreateAccountSubscriptionResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createAccountSubscriptionResponse_signupResponse :: Lens' CreateAccountSubscriptionResponse (Maybe SignupResponse) Source #

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

createAccountSubscriptionResponse_status :: Lens' CreateAccountSubscriptionResponse Int Source #

The HTTP status of the request.