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.
SearchDashboards
Busca paneles que pertenecen a un usuario.
Sintaxis de la solicitud
POST /accounts/AwsAccountId
/search/dashboards HTTP/1.1
Content-type: application/json
{
"Filters": [
{
"Name": "string
",
"Operator": "string
",
"Value": "string
"
}
],
"MaxResults": number
,
"NextToken": "string
"
}
Parámetros de solicitud URI
La solicitud utiliza los siguientes parámetros URI.
- AwsAccountId
-
El ID de la cuenta de AWS que contiene el usuario cuyos paneles está buscando.
Restricciones: Longitud fija de 12.
Patrón:
^[0-9]{12}$
: obligatorio Sí
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- Filtros
-
Los filtros que se aplicarán a la búsqueda. En la actualidad, puede buscar únicamente por nombre de usuario, por ejemplo,
"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
Tipo: Array deDashboardSearchFilterobjects
Miembros de Array Número fijo de 1 elemento.
: obligatorio Sí
- MaxResults
-
El número máximo de resultados que se van a devolver por solicitud.
Tipo: Entero
Rango válido Valor mínimo de 1. Valor máximo de 100.
: obligatorio No
- NextToken
-
El token para el conjunto siguiente de resultados o nulo si no hay más.
Tipo: Cadena
: obligatorio No
Sintaxis de la respuesta
HTTP/1.1 Status
Content-type: application/json
{
"DashboardSummaryList": [
{
"Arn": "string",
"CreatedTime": number,
"DashboardId": "string",
"LastPublishedTime": number,
"LastUpdatedTime": number,
"Name": "string",
"PublishedVersionNumber": number
}
],
"NextToken": "string",
"RequestId": "string"
}
Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve la respuesta HTTP siguiente.
- Estado
-
El estado HTTP de la solicitud.
El servicio devuelve los datos siguientes en formato JSON.
- DashboardSummaryList
-
La lista de paneles propiedad del usuario especificado en
Filters
En la solicitud de.Tipo: Array deDashboardSummaryobjects
Miembros de Array Número máximo de 100 elementos.
- NextToken
-
El token para el conjunto siguiente de resultados o nulo si no hay más.
Tipo: Cadena
- RequestId
-
ID de solicitud de AWS de esta operación.
Tipo: Cadena
Errors
Para obtener información sobre errores que son comunes a todas las acciones, consulteErrores comunes.
- InternalFailureException
-
Se produjo un error interno.
Código de estado HTTP: 500
- InvalidNextTokenException
-
El valor de
NextToken
no 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
- ResourceNotFoundException
-
No se encuentran uno o varios recursos.
Código de estado HTTP: 404
- ThrottlingException
-
El acceso está limitado.
Código de estado HTTP: 429
- UnsupportedUserEditionException
-
Este error indica que está llamando a una operación en una suscripción de Amazon QuickSight en la que la edición no admite esa operación. Las ediciones actuales de Amazon QuickSight son Standard Edition y Enterprise Edition. No todas las operaciones y funciones están disponibles en todas las ediciones.
Código de estado HTTP: 403
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: