Search

resourceexplorer_search

R Documentation

Searches for resources and displays details about all resources that match the specified criteria

Description

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.

Usage

resourceexplorer_search(MaxResults, NextToken, QueryString, ViewArn)

Arguments

MaxResults

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.

NextToken

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.

QueryString

[required] 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.

ViewArn

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.

Value

A list with the following syntax:

list(
  Count = list(
    Complete = TRUE|FALSE,
    TotalResources = 123
  ),
  NextToken = "string",
  Resources = list(
    list(
      Arn = "string",
      LastReportedAt = as.POSIXct(
        "2015-01-01"
      ),
      OwningAccountId = "string",
      Properties = list(
        list(
          Data = list(),
          LastReportedAt = as.POSIXct(
            "2015-01-01"
          ),
          Name = "string"
        )
      ),
      Region = "string",
      ResourceType = "string",
      Service = "string"
    )
  ),
  ViewArn = "string"
)

Request syntax

svc$search(
  MaxResults = 123,
  NextToken = "string",
  QueryString = "string",
  ViewArn = "string"
)