Operações internas de API - Guia do usuário avançado do AMS

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á.

Operações internas de API

Se você monitorar as operações da API, poderá ver chamadas para as seguintes operações somente internas:

  • GetDashboardUrl

  • ListReportsV2

Operação interna da API: GetDashboardUrl

Essa operação aparece nos registros do sistema quando invocada pelo console AMS. Não tem outro caso de uso. Ele não está disponível para seu uso direto.

Retorna o URL do painel incorporado para o relatório correspondente. Esta operação aceita um dashboardName retorno deListReports.

Sintaxe da solicitação

HTTP/1.1 200 Content-type: application/json { "dashboardName": "string" }

Elementos de solicitação

dashboardName: o nome do QuickSight painel para o qual o URL está sendo solicitado. O nome do painel é retornado na ListReports V2.

Tipo: String

Sintaxe da resposta

HTTP/1.1 200 Content-type: application/json { "url": "string" }

Elementos de resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço.

url: retorna a QuickSight URL da solicitaçãodashboardName.

Tipo: String

Erros

Para obter informações sobre os erros que são comuns a todas as ações, consulte Erros comuns.

BadRequestException:

A solicitação enviada não é válida. Por exemplo, se a entrada estiver incompleta ou incorreta. Consulte a mensagem de erro anexa para obter detalhes.

Código de status HTTP: 400

NotFoundException:

O recurso solicitado não foi encontrado. Verifique se o URI da solicitação está correto.

Código de status HTTP: 404

TooManyRequestsException:

A solicitação atingiu seu limite de limitação. Tente novamente após o período especificado.

Código de status HTTP: 429

UnauthorizedException:

A solicitação é negada porque o chamador não tem permissões suficientes.

Código de status HTTP: 401

Operação interna da API: ListReports V2

Essa API aparece nos registros do sistema quando invocada pelo console do AMS. Não tem outro caso de uso. Ele não está disponível para seu uso direto.

Retorna uma lista de relatórios operacionais que estão disponíveis para uma conta especificada.

Sintaxe da solicitação

A solicitação não tem um corpo de solicitação.

Sintaxe da resposta

HTTP/1.1 200 Content-type: application/json { "reportsList": [ { "dashboard": "string", "lastUpdatedTime": "string", } ], "reportsType": "string" }

Elementos de resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200. Os dados a seguir são retornados no formato JSON pelo serviço.

reportsList: A lista de relatórios operacionais disponíveis.

Tipo: Matriz de objetos do Dashboard

reportsType: indica se um relatório está agregado em várias contas ou não.

Tipo: String

Erros

Para obter informações sobre os erros que são comuns a todas as ações, consulte Erros comuns.

BadRequestException:

A solicitação enviada não é válida. Por exemplo, a entrada está incompleta ou incorreta. Consulte a mensagem de erro anexa para obter detalhes.

Código de status HTTP: 400

NotFoundException:

O recurso solicitado não foi encontrado. Verifique se o URI da solicitação está correto.

Código de status HTTP: 404

TooManyRequestsException:

A solicitação atingiu seu limite de limitação. Tente novamente após o período especificado.

Código de status HTTP: 429

UnauthorizedException:

A solicitação é negada porque o chamador não tem permissões suficientes.

Código de status HTTP: 401