[ aws . quicksight ]

search-groups

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  search-groups
--aws-account-id <value>
[--next-token <value>]
[--max-results <value>]
--namespace <value>
--filters <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

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.

--next-token (string)

A pagination token that can be used in a subsequent request.

--max-results (integer)

The maximum number of results to return from this request.

--namespace (string)

The namespace that you want to search.

--filters (list)

The structure for the search filters that you want to apply to your search.

(structure)

A GroupSearchFilter object that you want to apply to your search.

Operator -> (string)

The comparison operator that you want to use as a filter, for example "Operator": "StartsWith" . Currently, the only supported operator is StartsWith .

Name -> (string)

The name of the value that you want to use as a filter, for example "Name": "GROUP_NAME" . Currently, the only supported name is GROUP_NAME .

Value -> (string)

The value of the named item, in this case GROUP_NAME , that you want to use as a filter.

Shorthand Syntax:

Operator=string,Name=string,Value=string ...

JSON Syntax:

[
  {
    "Operator": "StartsWith",
    "Name": "GROUP_NAME",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

GroupList -> (list)

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

(structure)

A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security.

Arn -> (string)

The Amazon Resource Name (ARN) for the group.

GroupName -> (string)

The name of the group.

Description -> (string)

The group description.

PrincipalId -> (string)

The principal ID of the group.

NextToken -> (string)

A pagination token that can be used in a subsequent request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

Status -> (integer)

The HTTP status of the request.