Skip to content

/AWS1/IF_QST=>CREATEDATASOURCE()

About CreateDataSource

Creates a data source.

Method Signature

METHODS /AWS1/IF_QST~CREATEDATASOURCE
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_DATASOURCEID TYPE /AWS1/QSTRESOURCEID OPTIONAL
    !IV_NAME TYPE /AWS1/QSTRESOURCENAME OPTIONAL
    !IV_TYPE TYPE /AWS1/QSTDATASOURCETYPE OPTIONAL
    !IO_DATASOURCEPARAMETERS TYPE REF TO /AWS1/CL_QSTDATASOURCEPARAMS OPTIONAL
    !IO_CREDENTIALS TYPE REF TO /AWS1/CL_QSTDATASOURCECREDS OPTIONAL
    !IT_PERMISSIONS TYPE /AWS1/CL_QSTRESOURCEPERMISSION=>TT_RESOURCEPERMISSIONLIST OPTIONAL
    !IO_VPCCONNECTIONPROPERTIES TYPE REF TO /AWS1/CL_QSTVPCCONNPROPERTIES OPTIONAL
    !IO_SSLPROPERTIES TYPE REF TO /AWS1/CL_QSTSSLPROPERTIES OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST OPTIONAL
    !IT_FOLDERARNS TYPE /AWS1/CL_QSTFOLDERARNLIST_W=>TT_FOLDERARNLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstcreatedatasrcrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTCUSMANAGEDKEYUNA00
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTLIMITEXCEEDEDEX
    /AWS1/CX_QSTRESOURCEEXISTSEX
    /AWS1/CX_QSTRESOURCENOTFOUNDEX
    /AWS1/CX_QSTTHROTTLINGEX
    /AWS1/CX_QSTCLIENTEXC
    /AWS1/CX_QSTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_awsaccountid TYPE /AWS1/QSTAWSACCOUNTID /AWS1/QSTAWSACCOUNTID

The Amazon Web Services account ID.

iv_datasourceid TYPE /AWS1/QSTRESOURCEID /AWS1/QSTRESOURCEID

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

iv_name TYPE /AWS1/QSTRESOURCENAME /AWS1/QSTRESOURCENAME

A display name for the data source.

iv_type TYPE /AWS1/QSTDATASOURCETYPE /AWS1/QSTDATASOURCETYPE

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Optional arguments:

io_datasourceparameters TYPE REF TO /AWS1/CL_QSTDATASOURCEPARAMS /AWS1/CL_QSTDATASOURCEPARAMS

The parameters that Amazon Quick Sight uses to connect to your underlying source.

io_credentials TYPE REF TO /AWS1/CL_QSTDATASOURCECREDS /AWS1/CL_QSTDATASOURCECREDS

The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

it_permissions TYPE /AWS1/CL_QSTRESOURCEPERMISSION=>TT_RESOURCEPERMISSIONLIST TT_RESOURCEPERMISSIONLIST

A list of resource permissions on the data source.

io_vpcconnectionproperties TYPE REF TO /AWS1/CL_QSTVPCCONNPROPERTIES /AWS1/CL_QSTVPCCONNPROPERTIES

Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.

io_sslproperties TYPE REF TO /AWS1/CL_QSTSSLPROPERTIES /AWS1/CL_QSTSSLPROPERTIES

Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.

it_tags TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST TT_TAGLIST

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

it_folderarns TYPE /AWS1/CL_QSTFOLDERARNLIST_W=>TT_FOLDERARNLIST TT_FOLDERARNLIST

When you create the data source, Amazon Quick Sight adds the data source to these folders.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstcreatedatasrcrsp /AWS1/CL_QSTCREATEDATASRCRSP

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->createdatasource(
  io_credentials = new /aws1/cl_qstdatasourcecreds(
    io_credentialpair = new /aws1/cl_qstcredentialpair(
      it_alternatedatasourceparams = VALUE /aws1/cl_qstdatasourceparams=>tt_datasourceparameterslist(
        (
          new /aws1/cl_qstdatasourceparams(
            io_amazonelasticsearchparams = new /aws1/cl_qstamazonelasticsrc00( |string| )
            io_amazonopensearchparams = new /aws1/cl_qstamazonopensrchprms( |string| )
            io_athenaparameters = new /aws1/cl_qstathenaparameters(
              io_identitycenterconf = new /aws1/cl_qstidentitycenterconf( ABAP_TRUE )
              iv_rolearn = |string|
              iv_workgroup = |string|
            )
            io_auroraparameters = new /aws1/cl_qstauroraparameters(
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_aurorapostgresqlparams = new /aws1/cl_qstaurorapostgresql00(
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_awsiotanalyticsparameters = new /aws1/cl_qstawsiotalysparams( |string| )
            io_bigqueryparameters = new /aws1/cl_qstbigqueryparameters(
              iv_datasetregion = |string|
              iv_projectid = |string|
            )
            io_confluenceparameters = new /aws1/cl_qstconfluenceparams( |string| )
            io_customconnectionparams = new /aws1/cl_qstcustomconnparams( |string| )
            io_databricksparameters = new /aws1/cl_qstdatabricksparams(
              iv_host = |string|
              iv_port = 123
              iv_sqlendpointpath = |string|
            )
            io_exasolparameters = new /aws1/cl_qstexasolparameters(
              iv_host = |string|
              iv_port = 123
            )
            io_impalaparameters = new /aws1/cl_qstimpalaparameters(
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
              iv_sqlendpointpath = |string|
            )
            io_jiraparameters = new /aws1/cl_qstjiraparameters( |string| )
            io_mariadbparameters = new /aws1/cl_qstmariadbparameters(
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_mysqlparameters = new /aws1/cl_qstmysqlparameters(
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_oracleparameters = new /aws1/cl_qstoracleparameters(
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
              iv_useservicename = ABAP_TRUE
            )
            io_postgresqlparameters = new /aws1/cl_qstpostgresqlparams(
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_prestoparameters = new /aws1/cl_qstprestoparameters(
              iv_catalog = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_qbusinessparameters = new /aws1/cl_qstqbusinessparams( |string| )
            io_rdsparameters = new /aws1/cl_qstrdsparameters(
              iv_database = |string|
              iv_instanceid = |string|
            )
            io_redshiftparameters = new /aws1/cl_qstredshiftparameters(
              io_iamparameters = new /aws1/cl_qstredshiftiamparams(
                it_databasegroups = VALUE /aws1/cl_qstdatabasegrplist_w=>tt_databasegrouplist(
                  ( new /aws1/cl_qstdatabasegrplist_w( |string| ) )
                )
                iv_autocreatedatabaseuser = ABAP_TRUE
                iv_databaseuser = |string|
                iv_rolearn = |string|
              )
              io_identitycenterconf = new /aws1/cl_qstidentitycenterconf( ABAP_TRUE )
              iv_clusterid = |string|
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_s3knowledgebaseparameters = new /aws1/cl_qsts3knowledgebasep00(
              iv_bucketurl = |string|
              iv_metadatafileslocation = |string|
              iv_rolearn = |string|
            )
            io_s3parameters = new /aws1/cl_qsts3parameters(
              io_manifestfilelocation = new /aws1/cl_qstmanifestfileloc(
                iv_bucket = |string|
                iv_key = |string|
              )
              iv_rolearn = |string|
            )
            io_servicenowparameters = new /aws1/cl_qstservicenowparams( |string| )
            io_snowflakeparameters = new /aws1/cl_qstsnowflakeparams(
              io_oauthparameters = new /aws1/cl_qstoauthparameters(
                io_identitypvdrvpcconnprps = new /aws1/cl_qstvpcconnproperties( |string| )
                iv_identitypvdrresourceuri = |string|
                iv_oauthscope = |string|
                iv_tokenproviderurl = |string|
              )
              iv_authenticationtype = |string|
              iv_database = |string|
              iv_databaseaccesscontrolrole = |string|
              iv_host = |string|
              iv_warehouse = |string|
            )
            io_sparkparameters = new /aws1/cl_qstsparkparameters(
              iv_host = |string|
              iv_port = 123
            )
            io_sqlserverparameters = new /aws1/cl_qstsqlserverparams(
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_starburstparameters = new /aws1/cl_qststarburstparams(
              io_oauthparameters = new /aws1/cl_qstoauthparameters(
                io_identitypvdrvpcconnprps = new /aws1/cl_qstvpcconnproperties( |string| )
                iv_identitypvdrresourceuri = |string|
                iv_oauthscope = |string|
                iv_tokenproviderurl = |string|
              )
              iv_authenticationtype = |string|
              iv_catalog = |string|
              iv_databaseaccesscontrolrole = |string|
              iv_host = |string|
              iv_port = 123
              iv_producttype = |string|
            )
            io_teradataparameters = new /aws1/cl_qstteradataparameters(
              iv_database = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_trinoparameters = new /aws1/cl_qsttrinoparameters(
              iv_catalog = |string|
              iv_host = |string|
              iv_port = 123
            )
            io_twitterparameters = new /aws1/cl_qsttwitterparameters(
              iv_maxrows = 123
              iv_query = |string|
            )
            io_webcrawlerparameters = new /aws1/cl_qstwebcrawlerparams(
              iv_loginpageurl = |string|
              iv_passwordbuttonxpath = |string|
              iv_passwordfieldxpath = |string|
              iv_usernamebuttonxpath = |string|
              iv_usernamefieldxpath = |string|
              iv_webcrawlerauthtype = |string|
              iv_webproxyhostname = |string|
              iv_webproxyportnumber = 123
            )
          )
        )
      )
      iv_password = |string|
      iv_username = |string|
    )
    io_webproxycredentials = new /aws1/cl_qstwebproxycreds(
      iv_webproxypassword = |string|
      iv_webproxyusername = |string|
    )
    iv_copysourcearn = |string|
    iv_secretarn = |string|
  )
  io_datasourceparameters = new /aws1/cl_qstdatasourceparams(
    io_amazonelasticsearchparams = new /aws1/cl_qstamazonelasticsrc00( |string| )
    io_amazonopensearchparams = new /aws1/cl_qstamazonopensrchprms( |string| )
    io_athenaparameters = new /aws1/cl_qstathenaparameters(
      io_identitycenterconf = new /aws1/cl_qstidentitycenterconf( ABAP_TRUE )
      iv_rolearn = |string|
      iv_workgroup = |string|
    )
    io_auroraparameters = new /aws1/cl_qstauroraparameters(
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_aurorapostgresqlparams = new /aws1/cl_qstaurorapostgresql00(
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_awsiotanalyticsparameters = new /aws1/cl_qstawsiotalysparams( |string| )
    io_bigqueryparameters = new /aws1/cl_qstbigqueryparameters(
      iv_datasetregion = |string|
      iv_projectid = |string|
    )
    io_confluenceparameters = new /aws1/cl_qstconfluenceparams( |string| )
    io_customconnectionparams = new /aws1/cl_qstcustomconnparams( |string| )
    io_databricksparameters = new /aws1/cl_qstdatabricksparams(
      iv_host = |string|
      iv_port = 123
      iv_sqlendpointpath = |string|
    )
    io_exasolparameters = new /aws1/cl_qstexasolparameters(
      iv_host = |string|
      iv_port = 123
    )
    io_impalaparameters = new /aws1/cl_qstimpalaparameters(
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
      iv_sqlendpointpath = |string|
    )
    io_jiraparameters = new /aws1/cl_qstjiraparameters( |string| )
    io_mariadbparameters = new /aws1/cl_qstmariadbparameters(
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_mysqlparameters = new /aws1/cl_qstmysqlparameters(
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_oracleparameters = new /aws1/cl_qstoracleparameters(
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
      iv_useservicename = ABAP_TRUE
    )
    io_postgresqlparameters = new /aws1/cl_qstpostgresqlparams(
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_prestoparameters = new /aws1/cl_qstprestoparameters(
      iv_catalog = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_qbusinessparameters = new /aws1/cl_qstqbusinessparams( |string| )
    io_rdsparameters = new /aws1/cl_qstrdsparameters(
      iv_database = |string|
      iv_instanceid = |string|
    )
    io_redshiftparameters = new /aws1/cl_qstredshiftparameters(
      io_iamparameters = new /aws1/cl_qstredshiftiamparams(
        it_databasegroups = VALUE /aws1/cl_qstdatabasegrplist_w=>tt_databasegrouplist(
          ( new /aws1/cl_qstdatabasegrplist_w( |string| ) )
        )
        iv_autocreatedatabaseuser = ABAP_TRUE
        iv_databaseuser = |string|
        iv_rolearn = |string|
      )
      io_identitycenterconf = new /aws1/cl_qstidentitycenterconf( ABAP_TRUE )
      iv_clusterid = |string|
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_s3knowledgebaseparameters = new /aws1/cl_qsts3knowledgebasep00(
      iv_bucketurl = |string|
      iv_metadatafileslocation = |string|
      iv_rolearn = |string|
    )
    io_s3parameters = new /aws1/cl_qsts3parameters(
      io_manifestfilelocation = new /aws1/cl_qstmanifestfileloc(
        iv_bucket = |string|
        iv_key = |string|
      )
      iv_rolearn = |string|
    )
    io_servicenowparameters = new /aws1/cl_qstservicenowparams( |string| )
    io_snowflakeparameters = new /aws1/cl_qstsnowflakeparams(
      io_oauthparameters = new /aws1/cl_qstoauthparameters(
        io_identitypvdrvpcconnprps = new /aws1/cl_qstvpcconnproperties( |string| )
        iv_identitypvdrresourceuri = |string|
        iv_oauthscope = |string|
        iv_tokenproviderurl = |string|
      )
      iv_authenticationtype = |string|
      iv_database = |string|
      iv_databaseaccesscontrolrole = |string|
      iv_host = |string|
      iv_warehouse = |string|
    )
    io_sparkparameters = new /aws1/cl_qstsparkparameters(
      iv_host = |string|
      iv_port = 123
    )
    io_sqlserverparameters = new /aws1/cl_qstsqlserverparams(
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_starburstparameters = new /aws1/cl_qststarburstparams(
      io_oauthparameters = new /aws1/cl_qstoauthparameters(
        io_identitypvdrvpcconnprps = new /aws1/cl_qstvpcconnproperties( |string| )
        iv_identitypvdrresourceuri = |string|
        iv_oauthscope = |string|
        iv_tokenproviderurl = |string|
      )
      iv_authenticationtype = |string|
      iv_catalog = |string|
      iv_databaseaccesscontrolrole = |string|
      iv_host = |string|
      iv_port = 123
      iv_producttype = |string|
    )
    io_teradataparameters = new /aws1/cl_qstteradataparameters(
      iv_database = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_trinoparameters = new /aws1/cl_qsttrinoparameters(
      iv_catalog = |string|
      iv_host = |string|
      iv_port = 123
    )
    io_twitterparameters = new /aws1/cl_qsttwitterparameters(
      iv_maxrows = 123
      iv_query = |string|
    )
    io_webcrawlerparameters = new /aws1/cl_qstwebcrawlerparams(
      iv_loginpageurl = |string|
      iv_passwordbuttonxpath = |string|
      iv_passwordfieldxpath = |string|
      iv_usernamebuttonxpath = |string|
      iv_usernamefieldxpath = |string|
      iv_webcrawlerauthtype = |string|
      iv_webproxyhostname = |string|
      iv_webproxyportnumber = 123
    )
  )
  io_sslproperties = new /aws1/cl_qstsslproperties( ABAP_TRUE )
  io_vpcconnectionproperties = new /aws1/cl_qstvpcconnproperties( |string| )
  it_folderarns = VALUE /aws1/cl_qstfolderarnlist_w=>tt_folderarnlist(
    ( new /aws1/cl_qstfolderarnlist_w( |string| ) )
  )
  it_permissions = VALUE /aws1/cl_qstresourcepermission=>tt_resourcepermissionlist(
    (
      new /aws1/cl_qstresourcepermission(
        it_actions = VALUE /aws1/cl_qstactionlist_w=>tt_actionlist(
          ( new /aws1/cl_qstactionlist_w( |string| ) )
        )
        iv_principal = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_qsttag=>tt_taglist(
    (
      new /aws1/cl_qsttag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_awsaccountid = |string|
  iv_datasourceid = |string|
  iv_name = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_arn( ).
  lv_resourceid = lo_result->get_datasourceid( ).
  lv_resourcestatus = lo_result->get_creationstatus( ).
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.