Skip to content

/AWS1/IF_QST=>CREATEACTIONCONNECTOR()

About CreateActionConnector

Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.

Method Signature

METHODS /AWS1/IF_QST~CREATEACTIONCONNECTOR
  IMPORTING
    !IV_AWSACCOUNTID TYPE /AWS1/QSTAWSACCOUNTID OPTIONAL
    !IV_ACTIONCONNECTORID TYPE /AWS1/QSTSHORTRESTRICTIVERES00 OPTIONAL
    !IV_NAME TYPE /AWS1/QSTACTIONCONNECTORNAME OPTIONAL
    !IV_TYPE TYPE /AWS1/QSTACTIONCONNECTORTYPE OPTIONAL
    !IO_AUTHENTICATIONCONFIG TYPE REF TO /AWS1/CL_QSTAUTHCONFIG OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/QSTACTIONCONNECTORDESC OPTIONAL
    !IT_PERMISSIONS TYPE /AWS1/CL_QSTRESOURCEPERMISSION=>TT_RESOURCEPERMISSIONLIST OPTIONAL
    !IV_VPCCONNECTIONARN TYPE /AWS1/QSTARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_qstcreateactcnctorrsp
  RAISING
    /AWS1/CX_QSTACCESSDENIEDEX
    /AWS1/CX_QSTCONFLICTEXCEPTION
    /AWS1/CX_QSTINTERNALFAILUREEX
    /AWS1/CX_QSTINVPARAMVALUEEX
    /AWS1/CX_QSTRESOURCEEXISTSEX
    /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 associated with the action connector.

iv_actionconnectorid TYPE /AWS1/QSTSHORTRESTRICTIVERES00 /AWS1/QSTSHORTRESTRICTIVERES00

A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The ActionConnectorId must not start with the prefix quicksuite-

iv_name TYPE /AWS1/QSTACTIONCONNECTORNAME /AWS1/QSTACTIONCONNECTORNAME

A descriptive name for the action connector.

iv_type TYPE /AWS1/QSTACTIONCONNECTORTYPE /AWS1/QSTACTIONCONNECTORTYPE

The type of action connector.

io_authenticationconfig TYPE REF TO /AWS1/CL_QSTAUTHCONFIG /AWS1/CL_QSTAUTHCONFIG

The authentication configuration for connecting to the external service. This includes the authentication type, base URL, and authentication metadata such as client credentials or API keys.

Optional arguments:

iv_description TYPE /AWS1/QSTACTIONCONNECTORDESC /AWS1/QSTACTIONCONNECTORDESC

An optional description of the action connector.

it_permissions TYPE /AWS1/CL_QSTRESOURCEPERMISSION=>TT_RESOURCEPERMISSIONLIST TT_RESOURCEPERMISSIONLIST

The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.

iv_vpcconnectionarn TYPE /AWS1/QSTARN /AWS1/QSTARN

The ARN of the VPC connection to use for secure connectivity to the external service.

it_tags TYPE /AWS1/CL_QSTTAG=>TT_TAGLIST TT_TAGLIST

A list of tags to apply to the action connector for resource management and organization.

RETURNING

oo_output TYPE REF TO /aws1/cl_qstcreateactcnctorrsp /AWS1/CL_QSTCREATEACTCNCTORRSP

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->createactionconnector(
  io_authenticationconfig = new /aws1/cl_qstauthconfig(
    io_authenticationmetadata = new /aws1/cl_qstauthntctnmetadata(
      io_apikeyconnectionmetadata = new /aws1/cl_qstapikeyconnmetadata(
        iv_apikey = |string|
        iv_baseendpoint = |string|
        iv_email = |string|
      )
      io_authcodegrantmetadata = new /aws1/cl_qstauthcodegrantmet(
        io_authcodegrantcredsdetails = new /aws1/cl_qstauthcodegrantcre00(
          io_authcodegrantdetails = new /aws1/cl_qstauthcodegrantdets(
            iv_authorizationendpoint = |string|
            iv_clientid = |string|
            iv_clientsecret = |string|
            iv_tokenendpoint = |string|
          )
        )
        iv_authcodegrantcredssource = |string|
        iv_baseendpoint = |string|
        iv_redirecturl = |string|
      )
      io_basicauthconnmetadata = new /aws1/cl_qstbasicauthconnmet(
        iv_baseendpoint = |string|
        iv_password = |string|
        iv_username = |string|
      )
      io_clientcredsgrantmetadata = new /aws1/cl_qstclicredsgrantmet(
        io_clientcredentialsdetails = new /aws1/cl_qstclientcredsdetails(
          io_clientcredsgrantdetails = new /aws1/cl_qstclicredsgrantdets(
            iv_clientid = |string|
            iv_clientsecret = |string|
            iv_tokenendpoint = |string|
          )
        )
        iv_baseendpoint = |string|
        iv_clientcredentialssource = |string|
      )
      io_iamconnectionmetadata = new /aws1/cl_qstiamconnmetadata( |string| )
      io_noneconnectionmetadata = new /aws1/cl_qstnoneconnmetadata( |string| )
    )
    iv_authenticationtype = |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_actionconnectorid = |string|
  iv_awsaccountid = |string|
  iv_description = |string|
  iv_name = |string|
  iv_type = |string|
  iv_vpcconnectionarn = |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_resourcestatus = lo_result->get_creationstatus( ).
  lv_string = lo_result->get_actionconnectorid( ).
  lv_string = lo_result->get_requestid( ).
  lv_statuscode = lo_result->get_status( ).
ENDIF.