Search Groups

quicksight_search_groups

R Documentation

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters¶

Description¶

Use the search_groups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

Usage¶

quicksight_search_groups(AwsAccountId, NextToken, MaxResults, Namespace,
  Filters)

Arguments¶

AwsAccountId: [required] The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
NextToken: A pagination token that can be used in a subsequent request.
MaxResults: The maximum number of results to return from this request.
Namespace: [required] The namespace that you want to search.
Filters: [required] The structure for the search filters that you want to apply to your search.

Value¶

A list with the following syntax:

list(
  GroupList = list(
    list(
      Arn = "string",
      GroupName = "string",
      Description = "string",
      PrincipalId = "string"
    )
  ),
  NextToken = "string",
  RequestId = "string",
  Status = 123
)

Request syntax¶

svc$search_groups(
  AwsAccountId = "string",
  NextToken = "string",
  MaxResults = 123,
  Namespace = "string",
  Filters = list(
    list(
      Operator = "StartsWith",
      Name = "GROUP_NAME",
      Value = "string"
    )
  )
)