REGISTERCONNECTOR()`¶

About RegisterConnector¶

Registers a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.

Method Signature¶

METHODS /AWS1/IF_APF~REGISTERCONNECTOR
  IMPORTING
    !IV_CONNECTORLABEL TYPE /AWS1/APFCONNECTORLABEL OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/APFDESCRIPTION OPTIONAL
    !IV_CONNECTORPROVISIONINGTYPE TYPE /AWS1/APFCONNECTORPROVTYPE OPTIONAL
    !IO_CONNECTORPROVCONFIG TYPE REF TO /AWS1/CL_APFCNCTORPROVCONFIG OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/APFCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_apfregconnectorrsp
  RAISING
    /AWS1/CX_APFACCESSDENIEDEX
    /AWS1/CX_APFCONFLICTEXCEPTION
    /AWS1/CX_APFCNCTORAUTHNTCTNEX
    /AWS1/CX_APFCONNECTORSERVEREX
    /AWS1/CX_APFINTERNALSERVEREX
    /AWS1/CX_APFRESOURCENOTFOUNDEX
    /AWS1/CX_APFSERVICEQUOTAEXCDEX
    /AWS1/CX_APFTHROTTLINGEX
    /AWS1/CX_APFVALIDATIONEX
    /AWS1/CX_APFCLIENTEXC
    /AWS1/CX_APFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_connectorlabel` `TYPE /AWS1/APFCONNECTORLABEL` `/AWS1/APFCONNECTORLABEL`¶

The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.

`iv_description` `TYPE /AWS1/APFDESCRIPTION` `/AWS1/APFDESCRIPTION`¶

A description about the connector that's being registered.

`iv_connectorprovisioningtype` `TYPE /AWS1/APFCONNECTORPROVTYPE` `/AWS1/APFCONNECTORPROVTYPE`¶

The provisioning type of the connector. Currently the only supported value is LAMBDA.

`io_connectorprovconfig` `TYPE REF TO /AWS1/CL_APFCNCTORPROVCONFIG` `/AWS1/CL_APFCNCTORPROVCONFIG`¶

The provisioning type of the connector. Currently the only supported value is LAMBDA.

`iv_clienttoken` `TYPE /AWS1/APFCLIENTTOKEN` `/AWS1/APFCLIENTTOKEN`¶

The clientToken parameter is an idempotency token. It ensures that your RegisterConnector request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The token is active for 8 hours.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_apfregconnectorrsp` `/AWS1/CL_APFREGCONNECTORRSP`¶

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->registerconnector(
  io_connectorprovconfig = new /aws1/cl_apfcnctorprovconfig( new /aws1/cl_apflambdacnctorprov00( |string| ) )
  iv_clienttoken = |string|
  iv_connectorlabel = |string|
  iv_connectorprovisioningtype = |string|
  iv_description = |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_connectorarn( ).
ENDIF.

/AWS1/IF_APF=>REGISTERCONNECTOR()¶