Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
SearchGroups
UsarSearchGroupsoperación para buscar grupos en un Amazon específico QuickSight espacio de nombres mediante los filtros suministrados.
Sintaxis de la solicitud
POST /accounts/AwsAccountId/namespaces/Namespace/groups-search?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json
{
"Filters": [
{
"Name": "string",
"Operator": "string",
"Value": "string"
}
]
}Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- AwsAccountId
-
El ID de:AWScuenta en la que se encuentra el grupo. En la actualidad, utilizas el ID para elAWScuenta que contiene su Amazon QuickSight account.
restricciones de longitud: longitud fija de 12.
Patrón:
^[0-9]{12}$Obligatorio: Sí
- MaxResults
-
El número máximo de resultados que se devuelven en esta solicitud.
Rango válido: Valor mínimo de 1. Valor máximo de 100.
- Namespace
-
El espacio de nombres en el que se desea realizar una búsqueda.
restricciones de longitud: La longitud máxima es 64.
Patrón:
^[a-zA-Z0-9._-]*$Obligatorio: Sí
- NextToken
-
Un token de paginación que se pueda utilizar en una solicitud posterior.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- Filters
-
La estructura de los filtros de búsqueda que desea aplicar a la búsqueda.
Type: Matriz deGroupSearchFilterobjects
Miembros de la matriz: Número fijo de 1 elemento.
Obligatorio: Sí
Sintaxis de la respuesta
HTTP/1.1 Status
Content-type: application/json
{
"GroupList": [
{
"Arn": "string",
"Description": "string",
"GroupName": "string",
"PrincipalId": "string"
}
],
"NextToken": "string",
"RequestId": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve la siguiente respuesta HTTP.
- Status
-
El estado HTTP de la solicitud.
El servicio devuelve los datos siguientes en formato JSON.
- GroupList
-
Una lista de grupos en un espacio de nombres específico que coinciden con los filtros definidos en su
SearchGroupsrequest.Type: Matriz deGroupobjects
- NextToken
-
Un token de paginación que se pueda utilizar en una solicitud posterior.
Type: Cadena
- RequestId
-
LaAWSID de solicitud de para esta operación.
Type: Cadena
Errores
Para obtener información sobre los errores que son comunes a todas las acciones, consulteErrores comunes.
- AccessDeniedException
-
No tiene permiso de acceso. La credenciales proporcionadas no se pudieron validar. Es posible que no tenga autorización para realizar la solicitud. Asegúrese de que su cuenta esté autorizada para usar Amazon QuickSight , que las políticas tienen los permisos correctos y que está utilizando las claves de acceso correctas.
Código de estado HTTP: 401
- InternalFailureException
-
Se produjo un error interno.
Código de estado HTTP: 500
- InvalidNextTokenException
-
El valor de
NextTokenno es válido.Código de estado HTTP: 400
- InvalidParameterValueException
-
Uno o más parámetros tienen un valor que no es válido.
Código de estado HTTP: 400
- PreconditionNotMetException
-
No se cumplen una o varias condiciones previas.
Código de estado HTTP: 400
- ResourceNotFoundException
-
No se encuentran uno o varios recursos.
Código de estado HTTP: 404
- ResourceUnavailableException
-
Este recurso no está disponible en este momento.
Código de estado HTTP: 503
- ThrottlingException
-
El acceso está limitado.
Código de estado HTTP: 429
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte:
