SEARCH()`¶

About Search¶

Searches for resources and displays details about all resources that match the specified criteria. You must specify a query string.

All search queries must use a view. If you don't explicitly specify a view, then Amazon Web Services Resource Explorer uses the default view for the Amazon Web Services Region in which you call this operation. The results are the logical intersection of the results that match both the QueryString parameter supplied to this operation and the SearchFilter parameter attached to the view.

For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.

If your search results are empty, or are missing results that you think should be there, see Troubleshooting Resource Explorer search.

Method Signature¶

METHODS /AWS1/IF_RE2~SEARCH
  IMPORTING
    !IV_QUERYSTRING TYPE /AWS1/RE2QUERYSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/RE2INTEGER OPTIONAL
    !IV_VIEWARN TYPE /AWS1/RE2STRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/RE2STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_re2searchoutput
  RAISING
    /AWS1/CX_RE2ACCESSDENIEDEX
    /AWS1/CX_RE2INTERNALSERVEREX
    /AWS1/CX_RE2RESOURCENOTFOUNDEX
    /AWS1/CX_RE2THROTTLINGEX
    /AWS1/CX_RE2UNAUTHORIZEDEX
    /AWS1/CX_RE2VALIDATIONEX
    /AWS1/CX_RE2CLIENTEXC
    /AWS1/CX_RE2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_querystring` `TYPE /AWS1/RE2QUERYSTRING` `/AWS1/RE2QUERYSTRING`¶

A string that includes keywords and filters that specify the resources that you want to include in the results.

For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.

The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.

The operation can return only the first 1,000 results. If the resource you want is not included, then use a different value for QueryString to refine the results.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/RE2INTEGER` `/AWS1/RE2INTEGER`¶

The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

`iv_viewarn` `TYPE /AWS1/RE2STRING` `/AWS1/RE2STRING`¶

Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.

`iv_nexttoken` `TYPE /AWS1/RE2STRING` `/AWS1/RE2STRING`¶

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_re2searchoutput` `/AWS1/CL_RE2SEARCHOUTPUT`¶

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->search(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_querystring = |string|
  iv_viewarn = |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_resources( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_arn( ).
      lv_string = lo_row_1->get_owningaccountid( ).
      lv_string = lo_row_1->get_region( ).
      lv_string = lo_row_1->get_resourcetype( ).
      lv_string = lo_row_1->get_service( ).
      lv_timestamp = lo_row_1->get_lastreportedat( ).
      LOOP AT lo_row_1->get_properties( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_name( ).
          lv_timestamp = lo_row_3->get_lastreportedat( ).
          lo_value = lo_row_3->get_data( ).
          IF lo_value IS NOT INITIAL.
          ENDIF.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
  lv_string = lo_result->get_viewarn( ).
  lo_resourcecount = lo_result->get_count( ).
  IF lo_resourcecount IS NOT INITIAL.
    lv_long = lo_resourcecount->get_totalresources( ).
    lv_boolean = lo_resourcecount->get_complete( ).
  ENDIF.
ENDIF.

/AWS1/IF_RE2=>SEARCH()¶