Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateAccountSubscription

Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.

The Amazon Web Services Region for the account is derived from what is configured in the Amazon CLI or SDK.

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 in the Amazon Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Amazon Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sight in the Amazon Quick Sight 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 services using this API operation. To pass your existing IAM role to Amazon Quick Sight, see Passing IAM roles to Amazon Quick Sight in the Amazon Quick Sight User Guide.

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

Request Syntax


POST /account/AwsAccountId HTTP/1.1
Content-type: application/json

{
   "AccountName": "string",
   "ActiveDirectoryName": "string",
   "AdminGroup": [ "string" ],
   "AdminProGroup": [ "string" ],
   "AuthenticationMethod": "string",
   "AuthorGroup": [ "string" ],
   "AuthorProGroup": [ "string" ],
   "ContactNumber": "string",
   "DirectoryId": "string",
   "Edition": "string",
   "EmailAddress": "string",
   "FirstName": "string",
   "IAMIdentityCenterInstanceArn": "string",
   "LastName": "string",
   "NotificationEmail": "string",
   "ReaderGroup": [ "string" ],
   "ReaderProGroup": [ "string" ],
   "Realm": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The Amazon Web Services account ID of the account that you're using to create your Quick Sight 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 Quick Sight account. This name is unique over all of Amazon, and it appears only when users sign in. You can't change AccountName value after the Amazon Quick Sight account is created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 62.

Pattern: ^(?!D-|d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*

Required: Yes

AuthenticationMethod

The method that you want to use to authenticate your Quick Sight account.

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

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

Type: String

Valid Values: IAM_AND_QUICKSIGHT | IAM_ONLY | ACTIVE_DIRECTORY | IAM_IDENTITY_CENTER

Required: Yes

NotificationEmail

The email address that you want Quick Sight to send notifications to regarding your Quick Sight account or Quick Sight 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 Quick Sight account.

Type: String

Required: No

AdminGroup

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

For more information about using IAM Identity Center in Amazon Quick Sight, see Using IAM Identity Center with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide. For more information about using Active Directory in Amazon Quick Sight, see Using Active Directory with Amazon Quick Sight Enterprise Edition in the Amazon Quick Sight User Guide.

Type: Array of strings

Required: No

AdminProGroup

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Quick Sight account.

Type: Array of strings

Required: No

AuthorGroup

The author group associated with your Active Directory or IAM Identity Center account.

Type: Array of strings

Required: No

AuthorProGroup

The author pro group associated with your Active Directory or IAM Identity Center account.

Type: Array of strings

Required: No

ContactNumber

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

Type: String

Required: No

DirectoryId

The ID of the Active Directory that is associated with your Quick Sight account.

Type: String

Required: No

Edition

The edition of Amazon Quick Sight 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: No

EmailAddress

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

Type: String

Required: No

FirstName

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

Type: String

Required: No

IAMIdentityCenterInstanceArn

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

Type: String

Required: No

LastName

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

Type: String

Required: No

ReaderGroup

The reader group associated with your Active Directory or IAM Identity Center account.

Type: Array of strings

Required: No

ReaderProGroup

The reader pro group associated with your Active Directory or IAM Identity Center account.

Type: Array of strings

Required: No

Realm

The realm of the Active Directory that is associated with your Quick Sight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Quick Sight 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 Amazon request ID for this operation.

Type: String

SignupResponse

A SignupResponse object that returns information about a newly created Quick Sight 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 Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

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

RequestId: The Amazon request ID for this request.

HTTP Status Code: 400

PreconditionNotMetException

One or more preconditions aren't met.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 400

ResourceExistsException

The resource specified already exists.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 429