SEARCHWORKSPACEASSOCIATIONS()`¶

About SearchWorkspaceAssociations¶

Searches for workspace associations with users or routing profiles based on various criteria.

Method Signature¶

METHODS /AWS1/IF_CNT~SEARCHWORKSPACEASSOCIATIONS
  IMPORTING
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CNTNEXTTOKEN2500 OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CNTMAXRESULT500 OPTIONAL
    !IO_SEARCHFILTER TYPE REF TO /AWS1/CL_CNTWORKSPACEASCEARC00 OPTIONAL
    !IO_SEARCHCRITERIA TYPE REF TO /AWS1/CL_CNTWORKSPACEASCEARC01 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntsrchworkspaceasc01
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_instanceid` `TYPE /AWS1/CNTINSTANCEID` `/AWS1/CNTINSTANCEID`¶

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/CNTNEXTTOKEN2500` `/AWS1/CNTNEXTTOKEN2500`¶

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

`iv_maxresults` `TYPE /AWS1/CNTMAXRESULT500` `/AWS1/CNTMAXRESULT500`¶

The maximum number of results to return per page.

`io_searchfilter` `TYPE REF TO /AWS1/CL_CNTWORKSPACEASCEARC00` `/AWS1/CL_CNTWORKSPACEASCEARC00`¶

Filters to apply to the search, such as tag-based filters.

`io_searchcriteria` `TYPE REF TO /AWS1/CL_CNTWORKSPACEASCEARC01` `/AWS1/CL_CNTWORKSPACEASCEARC01`¶

The search criteria, including workspace ID, resource ID, or resource type.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntsrchworkspaceasc01` `/AWS1/CL_CNTSRCHWORKSPACEASC01`¶

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->searchworkspaceassociations(
  io_searchcriteria = new /aws1/cl_cntworkspaceascearc01(
    io_stringcondition = new /aws1/cl_cntstringcondition(
      iv_comparisontype = |string|
      iv_fieldname = |string|
      iv_value = |string|
    )
    it_andconditions = VALUE /aws1/cl_cntworkspaceascearc01=>tt_workspaceassocsrchcondlist(
      (
        new /aws1/cl_cntworkspaceascearc01(
          io_stringcondition = new /aws1/cl_cntstringcondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_value = |string|
          )
          it_orconditions = VALUE /aws1/cl_cntworkspaceascearc01=>tt_workspaceassocsrchcondlist(
          )
        )
      )
    )
    it_orconditions = VALUE /aws1/cl_cntworkspaceascearc01=>tt_workspaceassocsrchcondlist(
      (
        new /aws1/cl_cntworkspaceascearc01(
          io_stringcondition = new /aws1/cl_cntstringcondition(
            iv_comparisontype = |string|
            iv_fieldname = |string|
            iv_value = |string|
          )
          it_andconditions = VALUE /aws1/cl_cntworkspaceascearc01=>tt_workspaceassocsrchcondlist(
          )
        )
      )
    )
  )
  io_searchfilter = new /aws1/cl_cntworkspaceascearc00(
    io_attributefilter = new /aws1/cl_cntctlplaneattrfilter(
      io_andcondition = new /aws1/cl_cntcommonattrandcond(
        it_tagconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
          (
            new /aws1/cl_cnttagcondition(
              iv_tagkey = |string|
              iv_tagvalue = |string|
            )
          )
        )
      )
      io_tagcondition = new /aws1/cl_cnttagcondition(
        iv_tagkey = |string|
        iv_tagvalue = |string|
      )
      it_orconditions = VALUE /aws1/cl_cntcommonattrandcond=>tt_commonattrorconditionlist(
        (
          new /aws1/cl_cntcommonattrandcond(
            it_tagconditions = VALUE /aws1/cl_cnttagcondition=>tt_tagandconditionlist(
              (
                new /aws1/cl_cnttagcondition(
                  iv_tagkey = |string|
                  iv_tagvalue = |string|
                )
              )
            )
          )
        )
      )
    )
  )
  iv_instanceid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_workspaceassociations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_workspaceid = lo_row_1->get_workspaceid( ).
      lv_arn = lo_row_1->get_workspacearn( ).
      lv_workspaceassociatedreso = lo_row_1->get_resourceid( ).
      lv_arn = lo_row_1->get_resourcearn( ).
      lv_workspaceassociatedreso_1 = lo_row_1->get_resourcetype( ).
      lv_workspaceassociatedreso_2 = lo_row_1->get_resourcename( ).
    ENDIF.
  ENDLOOP.
  lv_approximatetotalcount = lo_result->get_approximatetotalcount( ).
ENDIF.

/AWS1/IF_CNT=>SEARCHWORKSPACEASSOCIATIONS()¶