Skip to content

Searches for agents based on specified filters

Description

Searches for agents based on specified filters.

Usage

quicksight_search_agents(AwsAccountId, Filters, MaxResults, NextToken)

Arguments

  • AwsAccountId

[required] The ID of the Amazon Web Services account that contains the agents.

  • Filters

[required] The filters to apply when searching agents.

  • MaxResults

The maximum number of results to return.

  • NextToken

The token for the next set of results, or null if there are no more results.

Value

A list with the following syntax:

list(
  AgentSummaries = list(
    list(
      Arn = "string",
      AgentId = "string",
      Name = "string",
      Description = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      IconId = "string"
    )
  ),
  NextToken = "string",
  RequestId = "string"
)

Request syntax

svc$search_agents(
  AwsAccountId = "string",
  Filters = list(
    list(
      Name = "DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"AGENT_NAME",
      Operator = "StringEquals"|"StringLike",
      Value = "string"
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)