CreateAccountSubscription - Amazon QuickSight

CreateAccountSubscription

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

The AWS Region for the account is derived from what is configured in the AWS 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 AWS account. If you don't have an AWS account, see Sign up for AWS in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct AWS 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 AWS 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 AWS services, see Setting default resource access to AWS services in the Amazon QuickSight User Guide.

Request Syntax

POST /account/AwsAccountId HTTP/1.1 Content-type: application/json { "AccountName": "string", "ActiveDirectoryName": "string", "AdminGroup": [ "string" ], "AuthenticationMethod": "string", "AuthorGroup": [ "string" ], "ContactNumber": "string", "DirectoryId": "string", "Edition": "string", "EmailAddress": "string", "FirstName": "string", "LastName": "string", "NotificationEmail": "string", "ReaderGroup": [ "string" ], "Realm": "string" }

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

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

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

AccountName

The name of your Amazon QuickSight account. This name is unique over all of AWS, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.

Type: String

Required: Yes

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.

Type: String

Valid Values: IAM_AND_QUICKSIGHT | IAM_ONLY | ACTIVE_DIRECTORY

Required: Yes

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

Type: String

Valid Values: STANDARD | ENTERPRISE | ENTERPRISE_AND_Q

Required: Yes

NotificationEmail

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

Type: String

Required: Yes

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.

Type: String

Required: No

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.

Type: Array of strings

Required: No

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.

Type: Array of strings

Required: No

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.

Type: String

Required: No

DirectoryId

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

Type: String

Required: No

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.

Type: String

Required: No

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.

Type: String

Required: No

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.

Type: String

Required: No

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.

Type: Array of strings

Required: No

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.

Type: String

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "RequestId": "string", "SignupResponse": { "accountName": "string", "directoryType": "string", "IAMUser": boolean, "userLoginName": "string" } }

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status

The HTTP status of the request.

The following data is returned in JSON format by the service.

RequestId

The AWS request ID for this operation.

Type: String

SignupResponse

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

Type: SignupResponse object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

PreconditionNotMetException

One or more preconditions aren't met.

HTTP Status Code: 400

ResourceExistsException

The resource specified already exists.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: