QuickSight / Client / create_account_subscription

create_account_subscription

QuickSight.Client.create_account_subscription(**kwargs)

Creates an QuickSight account, or subscribes to QuickSight Q.

The Amazon Web Services Region for the account is derived from what is configured in the 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 Web Services in the Amazon QuickSight User Guide. The person who signs up for QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for QuickSight in the 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 QuickSight, see Passing IAM roles to QuickSight in the QuickSight User Guide.

You can’t set default resource access on the new account from the QuickSight API. Instead, add default resource access from the 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 QuickSight User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_account_subscription(
    Edition='STANDARD'|'ENTERPRISE'|'ENTERPRISE_AND_Q',
    AuthenticationMethod='IAM_AND_QUICKSIGHT'|'IAM_ONLY'|'ACTIVE_DIRECTORY'|'IAM_IDENTITY_CENTER',
    AwsAccountId='string',
    AccountName='string',
    NotificationEmail='string',
    ActiveDirectoryName='string',
    Realm='string',
    DirectoryId='string',
    AdminGroup=[
        'string',
    ],
    AuthorGroup=[
        'string',
    ],
    ReaderGroup=[
        'string',
    ],
    AdminProGroup=[
        'string',
    ],
    AuthorProGroup=[
        'string',
    ],
    ReaderProGroup=[
        'string',
    ],
    FirstName='string',
    LastName='string',
    EmailAddress='string',
    ContactNumber='string',
    IAMIdentityCenterInstanceArn='string'
)
Parameters:

  • Edition (string) –

    The edition of 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 (string) –

    [REQUIRED]

    The method that you want to use to authenticate your QuickSight 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.

  • AwsAccountId (string) –

    [REQUIRED]

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

  • AccountName (string) –

    [REQUIRED]

    The name of your 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 QuickSight account is created.

  • NotificationEmail (string) –

    [REQUIRED]

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

  • ActiveDirectoryName (string) – The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new QuickSight account.

  • Realm (string) – The realm of the Active Directory that is associated with your QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new QuickSight account.

  • DirectoryId (string) – The ID of the Active Directory that is associated with your QuickSight account.

  • AdminGroup (list) –

    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 QuickSight account.

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

    • (string) –

  • AuthorGroup (list) –

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

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

    • (string) –

  • ReaderGroup (list) –

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

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

    • (string) –

  • AdminProGroup (list) –

    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 QuickSight account.

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

    • (string) –

  • AuthorProGroup (list) –

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

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

    • (string) –

  • ReaderProGroup (list) –

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

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

    • (string) –

  • FirstName (string) – The first name of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.

  • LastName (string) – The last name of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.

  • EmailAddress (string) – The email address of the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.

  • ContactNumber (string) – A 10-digit phone number for the author of the QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new QuickSight account.

  • IAMIdentityCenterInstanceArn (string) – The Amazon Resource Name (ARN) for the IAM Identity Center instance.

Return type:

dict

Returns:

Response Syntax

{
    'SignupResponse': {
        'IAMUser': True|False,
        'userLoginName': 'string',
        'accountName': 'string',
        'directoryType': 'string'
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • SignupResponse (dict) –

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

      • IAMUser (boolean) –

        A Boolean that is TRUE if the QuickSight uses IAM as an authentication method.

      • userLoginName (string) –

        The user login name for your QuickSight account.

      • accountName (string) –

        The name of your QuickSight account.

      • directoryType (string) –

        The type of Active Directory that is being used to authenticate the QuickSight account. Valid values are SIMPLE_AD, AD_CONNECTOR, and MICROSOFT_AD.

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions