Search Dashboards

quicksight_search_dashboards

R Documentation

Searches for dashboards that belong to a user¶

Description¶

Searches for dashboards that belong to a user.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

Usage¶

quicksight_search_dashboards(AwsAccountId, Filters, NextToken,
  MaxResults)

Arguments¶

AwsAccountId: [required] The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
Filters: [required] The filters to apply to the search. Currently, you can search only by user name, for example, ⁠"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]⁠
NextToken: The token for the next set of results, or null if there are no more results.
MaxResults: The maximum number of results to be returned per request.

Value¶

A list with the following syntax:

list(
  DashboardSummaryList = list(
    list(
      Arn = "string",
      DashboardId = "string",
      Name = "string",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      PublishedVersionNumber = 123,
      LastPublishedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string",
  Status = 123,
  RequestId = "string"
)

Request syntax¶

svc$search_dashboards(
  AwsAccountId = "string",
  Filters = list(
    list(
      Operator = "StringEquals"|"StringLike",
      Name = "QUICKSIGHT_USER"|"QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DASHBOARD_NAME",
      Value = "string"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)