As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
SearchDashboards
Pesquisa por painéis que pertencem a um usuário.
nota
Essa operação é eventualmente consistente. Os resultados são de melhor esforço e podem não refletir atualizações e mudanças muito recentes.
Sintaxe da solicitação
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 da solicitação de URI
A solicitação usa os parâmetros de URI a seguir.
- AwsAccountId
-
O ID daAWSconta que contém o usuário cujos painéis você está procurando.
Restrições de tamanho: Comprimento fixo de 12.
Padrão:
^[0-9]{12}$Obrigatório: Sim
Corpo da solicitação
A solicitação aceita os dados a seguir no formato JSON.
- Filters
-
Os filtros a serem aplicados à pesquisa. Atualmente, você pode pesquisar apenas por nome de usuário, por exemplo,
"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]Type: Stral deDashboardSearchFilterobjetos
Membros da matriz: Número fixo de 1 item.
Obrigatório: Sim
- MaxResults
-
O número máximo de resultados a serem retornados por solicitação.
Type: Inteiro
Intervalo válido: Valor mínimo de 1. Valor máximo de 100.
Obrigatório: Não
- NextToken
-
O token para o próximo conjunto de resultados ou nulo se não houver mais resultados.
Type: String
Obrigatório: Não
Sintaxe da resposta
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 resposta
Se a ação for bem-sucedida, o serviço retornará a resposta HTTP a seguir.
- Status
-
O status HTTP da solicitação.
Os seguintes dados são retornados no formato JSON pelo serviço.
- DashboardSummaryList
-
A lista de painéis de propriedade do usuário especificada em
Filtersem sua solicitação.Type: Stral deDashboardSummaryobjetos
Membros da matriz: Número máximo de 100 itens.
- NextToken
-
O token para o próximo conjunto de resultados ou nulo se não houver mais resultados.
Type: String
- RequestId
-
OAWSID da solicitação para essa operação.
Type: String
Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulteErros comuns.
- InternalFailureException
-
Ocorreu um erro interno.
Código de status HTTP: 500
- InvalidNextTokenException
-
O valor
NextTokené inválido.Código de status HTTP: 400
- InvalidParameterValueException
-
Um ou mais parâmetros têm um valor que não é válido.
Código de status HTTP: 400
- ResourceNotFoundException
-
Não foi possível encontrar um ou mais recursos.
Código de status HTTP: 404
- ThrottlingException
-
O acesso é limitado.
Código de status HTTP: 429
- UnsupportedUserEditionException
-
Esse erro indica que você está chamando uma operação em uma Amazon QuickSightassinatura em que a edição não inclui suporte para essa operação. Amazon Amazon QuickSight atualmente está disponível na Standard Edition e Enterprise Edition. Nem todas operações e recursos estão disponível em todas as edições.
Código de status HTTP: 403
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte:
