POST

/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search

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

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

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.

Namespacestringrequired

The namespace that you want to search.

Query Params

next-tokenstring

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

max-resultsinteger

The maximum number of results to return from this request.

Body Params

Filtersarrayrequired

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}