/AWS1/IF_QST=>CREATEACCOUNTSUBSCRIPTION()

About 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 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 Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct 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 Web Services 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 Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon Quick Sight User Guide.

Method Signature

METHODS /AWS1/IF_QST~CREATEACCOUNTSUBSCRIPTION
  IMPORTING
    !IV_EDITION TYPE /AWS1/QSTEDITION OPTIONAL
    !IV_AUTHENTICATIONMETHOD TYPE /AWS1/QSTAUTHNTCTNMETHODOPTION OPTIONAL
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_ACCOUNTNAME TYPE /AWS1/QSTACCOUNTNAME OPTIONAL
    !IV_NOTIFICATIONEMAIL TYPE /AWS1/QSTSTRING OPTIONAL
    !IV_ACTIVEDIRECTORYNAME TYPE /AWS1/QSTSTRING OPTIONAL
    !IV_REALM TYPE /AWS1/QSTSTRING OPTIONAL
    !IV_DIRECTORYID TYPE /AWS1/QSTSTRING OPTIONAL
    !IT_ADMINGROUP TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST OPTIONAL
    !IT_AUTHORGROUP TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST OPTIONAL
    !IT_READERGROUP TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST OPTIONAL
    !IT_ADMINPROGROUP TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST OPTIONAL
    !IT_AUTHORPROGROUP TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST OPTIONAL
    !IT_READERPROGROUP TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST OPTIONAL
    !IV_FIRSTNAME TYPE /AWS1/QSTSTRING OPTIONAL
    !IV_LASTNAME TYPE /AWS1/QSTSTRING OPTIONAL
    !IV_EMAILADDRESS TYPE /AWS1/QSTSTRING OPTIONAL
    !IV_CONTACTNUMBER TYPE /AWS1/QSTSTRING OPTIONAL
    !IV_IAMIDCENTERINSTANCEARN TYPE /AWS1/QSTSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstcreacctsubscript01
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTPRECONDNOTMETEX
    /AWS1/CX_QSTRESOURCEEXISTSEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTRESOURCEUNAVAILEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_authenticationmethod TYPE /AWS1/QSTAUTHNTCTNMETHODOPTION /AWS1/QSTAUTHNTCTNMETHODOPTION

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.

iv_awsaccountid TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

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

iv_accountname TYPE /AWS1/QSTACCOUNTNAME /AWS1/QSTACCOUNTNAME

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

iv_notificationemail TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

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

Optional arguments:

iv_edition TYPE /AWS1/QSTEDITION /AWS1/QSTEDITION

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

iv_activedirectoryname TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

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

iv_realm TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

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.

iv_directoryid TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

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

it_admingroup TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST TT_GROUPSLIST

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.

it_authorgroup TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST TT_GROUPSLIST

The author group associated with your Active Directory or IAM Identity Center 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.

it_readergroup TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST TT_GROUPSLIST

The reader group associated with your Active Directory or IAM Identity Center 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.

it_adminprogroup TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST TT_GROUPSLIST

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.

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.

it_authorprogroup TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST TT_GROUPSLIST

The author pro group associated with your Active Directory or IAM Identity Center 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.

it_readerprogroup TYPE /AWS1/CL_QSTGROUPSLIST_W=>TT_GROUPSLIST TT_GROUPSLIST

The reader pro group associated with your Active Directory or IAM Identity Center 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.

iv_firstname TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

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.

iv_lastname TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

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.

iv_emailaddress TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

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.

iv_contactnumber TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

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.

iv_iamidcenterinstancearn TYPE /AWS1/QSTSTRING /AWS1/QSTSTRING

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

RETURNING

oo_output TYPE REF TO /aws1/cl_qstcreacctsubscript01 /AWS1/CL_QSTCREACCTSUBSCRIPT01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createaccountsubscription(
  it_admingroup = VALUE /aws1/cl_qstgroupslist_w=>tt_groupslist(
    ( new /aws1/cl_qstgroupslist_w( |string| ) )
  )
  it_adminprogroup = VALUE /aws1/cl_qstgroupslist_w=>tt_groupslist(
    ( new /aws1/cl_qstgroupslist_w( |string| ) )
  )
  it_authorgroup = VALUE /aws1/cl_qstgroupslist_w=>tt_groupslist(
    ( new /aws1/cl_qstgroupslist_w( |string| ) )
  )
  it_authorprogroup = VALUE /aws1/cl_qstgroupslist_w=>tt_groupslist(
    ( new /aws1/cl_qstgroupslist_w( |string| ) )
  )
  it_readergroup = VALUE /aws1/cl_qstgroupslist_w=>tt_groupslist(
    ( new /aws1/cl_qstgroupslist_w( |string| ) )
  )
  it_readerprogroup = VALUE /aws1/cl_qstgroupslist_w=>tt_groupslist(
    ( new /aws1/cl_qstgroupslist_w( |string| ) )
  )
  iv_accountname = |string|
  iv_activedirectoryname = |string|
  iv_authenticationmethod = |string|
  iv_awsaccountid = |string|
  iv_contactnumber = |string|
  iv_directoryid = |string|
  iv_edition = |string|
  iv_emailaddress = |string|
  iv_firstname = |string|
  iv_iamidcenterinstancearn = |string|
  iv_lastname = |string|
  iv_notificationemail = |string|
  iv_realm = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_signupresponse = lo_result->get_signupresponse( ).
  IF lo_signupresponse IS NOT INITIAL.
    lv_boolean = lo_signupresponse->get_iamuser( ).
    lv_string = lo_signupresponse->get_userloginname( ).
    lv_string = lo_signupresponse->get_accountname( ).
    lv_string = lo_signupresponse->get_directorytype( ).
  ENDIF.
  lv_statuscode = lo_result->get_status( ).
  lv_string = lo_result->get_requestid( ).
ENDIF.