/AWS1/IF_DZN=>LISTCONNECTIONS()¶
About ListConnections¶
Lists connections. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
Method Signature¶
METHODS /AWS1/IF_DZN~LISTCONNECTIONS
IMPORTING
!IV_DOMAINIDENTIFIER TYPE /AWS1/DZNDOMAINID OPTIONAL
!IV_MAXRESULTS TYPE /AWS1/DZNMAXRESULTS OPTIONAL
!IV_NEXTTOKEN TYPE /AWS1/DZNPAGINATIONTOKEN OPTIONAL
!IV_SORTBY TYPE /AWS1/DZNSORTFIELDCONNECTION OPTIONAL
!IV_SORTORDER TYPE /AWS1/DZNSORTORDER OPTIONAL
!IV_NAME TYPE /AWS1/DZNCONNECTIONNAME OPTIONAL
!IV_ENVIRONMENTIDENTIFIER TYPE /AWS1/DZNENVIRONMENTID OPTIONAL
!IV_PROJECTIDENTIFIER TYPE /AWS1/DZNPROJECTID OPTIONAL
!IV_TYPE TYPE /AWS1/DZNCONNECTIONTYPE OPTIONAL
!IV_SCOPE TYPE /AWS1/DZNCONNECTIONSCOPE OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dznlistconnsoutput
RAISING
/AWS1/CX_DZNACCESSDENIEDEX
/AWS1/CX_DZNTHROTTLINGEX
/AWS1/CX_DZNUNAUTHORIZEDEX
/AWS1/CX_DZNINTERNALSERVEREX
/AWS1/CX_DZNVALIDATIONEX
/AWS1/CX_DZNCLIENTEXC
/AWS1/CX_DZNSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_domainidentifier TYPE /AWS1/DZNDOMAINID /AWS1/DZNDOMAINID¶
The ID of the domain where you want to list connections.
Optional arguments:¶
iv_maxresults TYPE /AWS1/DZNMAXRESULTS /AWS1/DZNMAXRESULTS¶
The maximum number of connections to return in a single call to ListConnections. When the number of connections to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListConnections to list the next set of connections.
iv_nexttoken TYPE /AWS1/DZNPAGINATIONTOKEN /AWS1/DZNPAGINATIONTOKEN¶
When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.
iv_sortby TYPE /AWS1/DZNSORTFIELDCONNECTION /AWS1/DZNSORTFIELDCONNECTION¶
Specifies how you want to sort the listed connections.
iv_sortorder TYPE /AWS1/DZNSORTORDER /AWS1/DZNSORTORDER¶
Specifies the sort order for the listed connections.
iv_name TYPE /AWS1/DZNCONNECTIONNAME /AWS1/DZNCONNECTIONNAME¶
The name of the connection.
iv_environmentidentifier TYPE /AWS1/DZNENVIRONMENTID /AWS1/DZNENVIRONMENTID¶
The ID of the environment where you want to list connections.
iv_projectidentifier TYPE /AWS1/DZNPROJECTID /AWS1/DZNPROJECTID¶
The ID of the project where you want to list connections.
iv_type TYPE /AWS1/DZNCONNECTIONTYPE /AWS1/DZNCONNECTIONTYPE¶
The type of connection.
iv_scope TYPE /AWS1/DZNCONNECTIONSCOPE /AWS1/DZNCONNECTIONSCOPE¶
The scope of the connection.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_dznlistconnsoutput /AWS1/CL_DZNLISTCONNSOUTPUT¶
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->listconnections(
iv_domainidentifier = |string|
iv_environmentidentifier = |string|
iv_maxresults = 123
iv_name = |string|
iv_nexttoken = |string|
iv_projectidentifier = |string|
iv_scope = |string|
iv_sortby = |string|
iv_sortorder = |string|
iv_type = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
LOOP AT lo_result->get_items( ) into lo_row.
lo_row_1 = lo_row.
IF lo_row_1 IS NOT INITIAL.
LOOP AT lo_row_1->get_configurations( ) into lo_row_2.
lo_row_3 = lo_row_2.
IF lo_row_3 IS NOT INITIAL.
lv_string = lo_row_3->get_classification( ).
LOOP AT lo_row_3->get_properties( ) into ls_row_4.
lv_key = ls_row_4-key.
lo_value = ls_row_4-value.
IF lo_value IS NOT INITIAL.
lv_string = lo_value->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
ENDLOOP.
lv_connectionid = lo_row_1->get_connectionid( ).
lv_domainid = lo_row_1->get_domainid( ).
lv_domainunitid = lo_row_1->get_domainunitid( ).
lv_environmentid = lo_row_1->get_environmentid( ).
lv_connectionname = lo_row_1->get_name( ).
LOOP AT lo_row_1->get_physicalendpoints( ) into lo_row_5.
lo_row_6 = lo_row_5.
IF lo_row_6 IS NOT INITIAL.
lo_awslocation = lo_row_6->get_awslocation( ).
IF lo_awslocation IS NOT INITIAL.
lv_string = lo_awslocation->get_accessrole( ).
lv_awsaccountid = lo_awslocation->get_awsaccountid( ).
lv_awsregion = lo_awslocation->get_awsregion( ).
lv_connectionid = lo_awslocation->get_iamconnectionid( ).
ENDIF.
lv_string = lo_row_6->get_glueconnectionname( ).
LOOP AT lo_row_6->get_glueconnectionnames( ) into lo_row_7.
lo_row_8 = lo_row_7.
IF lo_row_8 IS NOT INITIAL.
lv_glueconnectionname = lo_row_8->get_value( ).
ENDIF.
ENDLOOP.
lo_glueconnection = lo_row_6->get_glueconnection( ).
IF lo_glueconnection IS NOT INITIAL.
lv_string = lo_glueconnection->get_name( ).
lv_string = lo_glueconnection->get_description( ).
lv_connectiontype = lo_glueconnection->get_connectiontype( ).
LOOP AT lo_glueconnection->get_matchcriteria( ) into lo_row_9.
lo_row_10 = lo_row_9.
IF lo_row_10 IS NOT INITIAL.
lv_string = lo_row_10->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_glueconnection->get_connectionproperties( ) into ls_row_11.
lv_key = ls_row_11-key.
lo_value_1 = ls_row_11-value.
IF lo_value_1 IS NOT INITIAL.
lv_string = lo_value_1->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_glueconnection->get_sparkproperties( ) into ls_row_4.
lv_key = ls_row_4-key.
lo_value = ls_row_4-value.
IF lo_value IS NOT INITIAL.
lv_string = lo_value->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_glueconnection->get_athenaproperties( ) into ls_row_4.
lv_key = ls_row_4-key.
lo_value = ls_row_4-value.
IF lo_value IS NOT INITIAL.
lv_string = lo_value->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_glueconnection->get_pythonproperties( ) into ls_row_4.
lv_key = ls_row_4-key.
lo_value = ls_row_4-value.
IF lo_value IS NOT INITIAL.
lv_string = lo_value->get_value( ).
ENDIF.
ENDLOOP.
lo_physicalconnectionrequi = lo_glueconnection->get_physicalconnrequirements( ).
IF lo_physicalconnectionrequi IS NOT INITIAL.
lv_subnetid = lo_physicalconnectionrequi->get_subnetid( ).
LOOP AT lo_physicalconnectionrequi->get_subnetidlist( ) into lo_row_12.
lo_row_13 = lo_row_12.
IF lo_row_13 IS NOT INITIAL.
lv_subnetid = lo_row_13->get_value( ).
ENDIF.
ENDLOOP.
LOOP AT lo_physicalconnectionrequi->get_securitygroupidlist( ) into lo_row_14.
lo_row_15 = lo_row_14.
IF lo_row_15 IS NOT INITIAL.
lv_string = lo_row_15->get_value( ).
ENDIF.
ENDLOOP.
lv_string = lo_physicalconnectionrequi->get_availabilityzone( ).
ENDIF.
lv_timestamp = lo_glueconnection->get_creationtime( ).
lv_timestamp = lo_glueconnection->get_lastupdatedtime( ).
lv_string = lo_glueconnection->get_lastupdatedby( ).
lv_connectionstatus = lo_glueconnection->get_status( ).
lv_string = lo_glueconnection->get_statusreason( ).
lv_timestamp = lo_glueconnection->get_lastconnvalidationtime( ).
lo_authenticationconfigura = lo_glueconnection->get_authntctnconfiguration( ).
IF lo_authenticationconfigura IS NOT INITIAL.
lv_authenticationtype = lo_authenticationconfigura->get_authenticationtype( ).
lv_string = lo_authenticationconfigura->get_secretarn( ).
lo_oauth2properties = lo_authenticationconfigura->get_oauth2properties( ).
IF lo_oauth2properties IS NOT INITIAL.
lv_oauth2granttype = lo_oauth2properties->get_oauth2granttype( ).
lo_oauth2clientapplication = lo_oauth2properties->get_oauth2clientapplication( ).
IF lo_oauth2clientapplication IS NOT INITIAL.
lv_string = lo_oauth2clientapplication->get_usermanagedcliapplicat00( ).
lv_string = lo_oauth2clientapplication->get_awsmanagedcliapplicati00( ).
ENDIF.
lv_string = lo_oauth2properties->get_tokenurl( ).
LOOP AT lo_oauth2properties->get_tokenurlparametersmap( ) into ls_row_16.
lv_key = ls_row_16-key.
lo_value_2 = ls_row_16-value.
IF lo_value_2 IS NOT INITIAL.
lv_string = lo_value_2->get_value( ).
ENDIF.
ENDLOOP.
lo_authorizationcodeproper = lo_oauth2properties->get_authcodeproperties( ).
IF lo_authorizationcodeproper IS NOT INITIAL.
lv_string = lo_authorizationcodeproper->get_authorizationcode( ).
lv_string = lo_authorizationcodeproper->get_redirecturi( ).
ENDIF.
lo_glueoauth2credentials = lo_oauth2properties->get_oauth2credentials( ).
IF lo_glueoauth2credentials IS NOT INITIAL.
lv_string = lo_glueoauth2credentials->get_usermanagedcliapplicat01( ).
lv_string = lo_glueoauth2credentials->get_accesstoken( ).
lv_string = lo_glueoauth2credentials->get_refreshtoken( ).
lv_string = lo_glueoauth2credentials->get_jwttoken( ).
ENDIF.
ENDIF.
ENDIF.
lv_integer = lo_glueconnection->get_connectionschemaversion( ).
LOOP AT lo_glueconnection->get_compatiblecomputeenvir00( ) into lo_row_17.
lo_row_18 = lo_row_17.
IF lo_row_18 IS NOT INITIAL.
lv_computeenvironments = lo_row_18->get_value( ).
ENDIF.
ENDLOOP.
ENDIF.
lv_boolean = lo_row_6->get_enabletrstdidpropagation( ).
lv_string = lo_row_6->get_host( ).
lv_integer = lo_row_6->get_port( ).
lv_protocol = lo_row_6->get_protocol( ).
lv_string = lo_row_6->get_stage( ).
ENDIF.
ENDLOOP.
lv_projectid = lo_row_1->get_projectid( ).
lo_connectionpropertiesout = lo_row_1->get_props( ).
IF lo_connectionpropertiesout IS NOT INITIAL.
lo_athenapropertiesoutput = lo_connectionpropertiesout->get_athenaproperties( ).
IF lo_athenapropertiesoutput IS NOT INITIAL.
lv_string = lo_athenapropertiesoutput->get_workgroupname( ).
ENDIF.
lo_gluepropertiesoutput = lo_connectionpropertiesout->get_glueproperties( ).
IF lo_gluepropertiesoutput IS NOT INITIAL.
lv_connectionstatus = lo_gluepropertiesoutput->get_status( ).
lv_string = lo_gluepropertiesoutput->get_errormessage( ).
ENDIF.
lo_hyperpodpropertiesoutpu = lo_connectionpropertiesout->get_hyperpodproperties( ).
IF lo_hyperpodpropertiesoutpu IS NOT INITIAL.
lv_string = lo_hyperpodpropertiesoutpu->get_clustername( ).
lv_string = lo_hyperpodpropertiesoutpu->get_clusterarn( ).
lv_hyperpodorchestrator = lo_hyperpodpropertiesoutpu->get_orchestrator( ).
ENDIF.
lo_iampropertiesoutput = lo_connectionpropertiesout->get_iamproperties( ).
IF lo_iampropertiesoutput IS NOT INITIAL.
lv_string = lo_iampropertiesoutput->get_environmentid( ).
lv_boolean = lo_iampropertiesoutput->get_gluelineagesyncenabled( ).
ENDIF.
lo_redshiftpropertiesoutpu = lo_connectionpropertiesout->get_redshiftproperties( ).
IF lo_redshiftpropertiesoutpu IS NOT INITIAL.
lo_redshiftstorageproperti = lo_redshiftpropertiesoutpu->get_storage( ).
IF lo_redshiftstorageproperti IS NOT INITIAL.
lv_string = lo_redshiftstorageproperti->get_clustername( ).
lv_string = lo_redshiftstorageproperti->get_workgroupname( ).
ENDIF.
lo_redshiftcredentials = lo_redshiftpropertiesoutpu->get_credentials( ).
IF lo_redshiftcredentials IS NOT INITIAL.
lv_string = lo_redshiftcredentials->get_secretarn( ).
lo_usernamepassword = lo_redshiftcredentials->get_usernamepassword( ).
IF lo_usernamepassword IS NOT INITIAL.
lv_password = lo_usernamepassword->get_password( ).
lv_username = lo_usernamepassword->get_username( ).
ENDIF.
ENDIF.
lv_boolean = lo_redshiftpropertiesoutpu->get_isprovisionedsecret( ).
lv_string = lo_redshiftpropertiesoutpu->get_jdbciamurl( ).
lv_string = lo_redshiftpropertiesoutpu->get_jdbcurl( ).
lv_string = lo_redshiftpropertiesoutpu->get_redshifttempdir( ).
lo_redshiftlineagesyncconf = lo_redshiftpropertiesoutpu->get_lineagesync( ).
IF lo_redshiftlineagesyncconf IS NOT INITIAL.
lv_string = lo_redshiftlineagesyncconf->get_lineagejobid( ).
lv_boolean = lo_redshiftlineagesyncconf->get_enabled( ).
lo_lineagesyncschedule = lo_redshiftlineagesyncconf->get_schedule( ).
IF lo_lineagesyncschedule IS NOT INITIAL.
lv_string = lo_lineagesyncschedule->get_schedule( ).
ENDIF.
ENDIF.
lv_connectionstatus = lo_redshiftpropertiesoutpu->get_status( ).
lv_string = lo_redshiftpropertiesoutpu->get_databasename( ).
ENDIF.
lo_sparkemrpropertiesoutpu = lo_connectionpropertiesout->get_sparkemrproperties( ).
IF lo_sparkemrpropertiesoutpu IS NOT INITIAL.
lv_string = lo_sparkemrpropertiesoutpu->get_computearn( ).
lo_usernamepassword = lo_sparkemrpropertiesoutpu->get_credentials( ).
IF lo_usernamepassword IS NOT INITIAL.
lv_password = lo_usernamepassword->get_password( ).
lv_username = lo_usernamepassword->get_username( ).
ENDIF.
lv_timestamp = lo_sparkemrpropertiesoutpu->get_credentialsexpiration( ).
lv_governancetype = lo_sparkemrpropertiesoutpu->get_governancetype( ).
lv_string = lo_sparkemrpropertiesoutpu->get_instanceprofilearn( ).
lv_string = lo_sparkemrpropertiesoutpu->get_javavirtualenv( ).
lv_string = lo_sparkemrpropertiesoutpu->get_livyendpoint( ).
lv_string = lo_sparkemrpropertiesoutpu->get_loguri( ).
lv_string = lo_sparkemrpropertiesoutpu->get_pythonvirtualenv( ).
lv_string = lo_sparkemrpropertiesoutpu->get_runtimerole( ).
lv_string = lo_sparkemrpropertiesoutpu->get_trustedcertificatess3uri( ).
lv_string = lo_sparkemrpropertiesoutpu->get_certificatedata( ).
lv_string = lo_sparkemrpropertiesoutpu->get_managedendpointarn( ).
lo_managedendpointcredenti = lo_sparkemrpropertiesoutpu->get_managedendpointcreds( ).
IF lo_managedendpointcredenti IS NOT INITIAL.
lv_string = lo_managedendpointcredenti->get_id( ).
lv_string = lo_managedendpointcredenti->get_token( ).
ENDIF.
ENDIF.
lo_sparkgluepropertiesoutp = lo_connectionpropertiesout->get_sparkglueproperties( ).
IF lo_sparkgluepropertiesoutp IS NOT INITIAL.
lo_sparkglueargs = lo_sparkgluepropertiesoutp->get_additionalargs( ).
IF lo_sparkglueargs IS NOT INITIAL.
lv_string = lo_sparkglueargs->get_connection( ).
ENDIF.
lv_string = lo_sparkgluepropertiesoutp->get_glueconnectionname( ).
LOOP AT lo_sparkgluepropertiesoutp->get_glueconnectionnames( ) into lo_row_7.
lo_row_8 = lo_row_7.
IF lo_row_8 IS NOT INITIAL.
lv_glueconnectionname = lo_row_8->get_value( ).
ENDIF.
ENDLOOP.
lv_string = lo_sparkgluepropertiesoutp->get_glueversion( ).
lv_integer = lo_sparkgluepropertiesoutp->get_idletimeout( ).
lv_string = lo_sparkgluepropertiesoutp->get_javavirtualenv( ).
lv_integer = lo_sparkgluepropertiesoutp->get_numberofworkers( ).
lv_string = lo_sparkgluepropertiesoutp->get_pythonvirtualenv( ).
lv_string = lo_sparkgluepropertiesoutp->get_workertype( ).
ENDIF.
lo_s3propertiesoutput = lo_connectionpropertiesout->get_s3properties( ).
IF lo_s3propertiesoutput IS NOT INITIAL.
lv_s3uri = lo_s3propertiesoutput->get_s3uri( ).
lv_s3accessgrantlocationid = lo_s3propertiesoutput->get_s3accessgrantlocationid( ).
lv_boolean = lo_s3propertiesoutput->get_regs3accessgrantlocation( ).
lv_connectionstatus = lo_s3propertiesoutput->get_status( ).
lv_string = lo_s3propertiesoutput->get_errormessage( ).
ENDIF.
lo_amazonqpropertiesoutput = lo_connectionpropertiesout->get_amazonqproperties( ).
IF lo_amazonqpropertiesoutput IS NOT INITIAL.
lv_boolean = lo_amazonqpropertiesoutput->get_isenabled( ).
lv_string = lo_amazonqpropertiesoutput->get_profilearn( ).
lv_string = lo_amazonqpropertiesoutput->get_authmode( ).
ENDIF.
lo_mlflowpropertiesoutput = lo_connectionpropertiesout->get_mlflowproperties( ).
IF lo_mlflowpropertiesoutput IS NOT INITIAL.
lv_string = lo_mlflowpropertiesoutput->get_trackingserverarn( ).
ENDIF.
lo_workflowsmwaaproperties = lo_connectionpropertiesout->get_workflowsmwaaproperties( ).
IF lo_workflowsmwaaproperties IS NOT INITIAL.
lv_string = lo_workflowsmwaaproperties->get_mwaaenvironmentname( ).
ENDIF.
lo_workflowsserverlessprop = lo_connectionpropertiesout->get_workflowssvrlsproperties( ).
IF lo_workflowsserverlessprop IS NOT INITIAL.
ENDIF.
ENDIF.
lv_connectiontype = lo_row_1->get_type( ).
lv_connectionscope = lo_row_1->get_scope( ).
ENDIF.
ENDLOOP.
lv_paginationtoken = lo_result->get_nexttoken( ).
ENDIF.