GetDashboardEmbedUrl - Amazon QuickSight
Sintaxe da solicitaçãoParâmetros da solicitação de URICorpo da solicitaçãoSintaxe da respostaElementos de respostaErrosConsulte também

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

GetDashboardEmbedUrl

Gera um URL de sessão temporária e um código de autorização (token de portador) que você pode usar para incorporar uma Amazon QuickSight painel somente leitura em seu site ou aplicativo. Antes de usar esse comando, verifique se você configurou os painéis e as permissões.

No momento, você pode usarGetDashboardEmbedURLsomente do servidor, não do navegador do usuário. As seguintes regras se aplicam ao URL gerado:

  • Eles devem ser usados conjuntamente.

  • Eles podem ser usados apenas uma vez.

  • Eles são válidos por 5 minutos após a execução do comando.

  • Você será cobrado somente quando o URL for usado ou houver interação com a Amazon QuickSight.

  • A sessão de usuário resultante é válida por 15 minutos (padrão) até 10 horas (máximo). Você pode usar o opcionalSessionLifetimeInMinutesparâmetro para personalizar a duração da sessão.

Para obter mais informações, consulteIncorporação de análise usando GetDashboardEmbedUrlnoAmazônia QuickSight Guia do usuário do.

Para obter mais informações sobre as etapas de alto nível para incorporação e para uma demonstração interativa das maneiras como você pode personalizar a incorporação, visite oAmazônia QuickSight Portal do desenvolvedor.

Sintaxe da solicitação

GET /accounts/AwsAccountId/dashboards/DashboardId/embed-url?additional-dashboard-ids=AdditionalDashboardIds&creds-type=IdentityType&namespace=Namespace&reset-disabled=ResetDisabled&session-lifetime=SessionLifetimeInMinutes&state-persistence-enabled=StatePersistenceEnabled&undo-redo-disabled=UndoRedoDisabled&user-arn=UserArn HTTP/1.1

Parâmetros da solicitação de URI

A solicitação usa os parâmetros de URI a seguir.

AdditionalDashboardIds

Uma lista de um ou mais IDs de painel aos quais você deseja que usuários anônimos tenham acesso temporário. No momento, oIdentityTypeparâmetro deve ser definido comoANONYMOUSporque outros tipos de identidade são autenticados como Amazon QuickSight ou usuários do IAM. Por exemplo, se você definir”--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS“, a sessão pode acessar todos os três painéis.

Membros da matriz: Número mínimo de 1 item. Número máximo de 20 itens.

Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 2048.

Padrão: [\w\-]+

AwsAccountId

O ID doConta da AWSque contém o painel que você está incorporando.

Restrições de comprimento: Comprimento fixo de 12.

Padrão: ^[0-9]{12}$

Obrigatório: Sim

DashboardId

ID do painel, também adicionado aoAWS Identity and Access ManagementPolítica do (IAM).

Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 2048.

Padrão: [\w\-]+

Obrigatório: Sim

IdentityType

O método de autenticação que o usuário usa para fazer login.

Valores válidos: IAM | QUICKSIGHT | ANONYMOUS

Obrigatório: Sim

Namespace

O Amazon (Amazon QuickSight namespace que contém os IDs do painel nessa solicitação. Se você não estiver usando um namespace personalizado, definaNamespace = default.

Restrições de comprimento: Tamanho máximo de 64.

Padrão: ^[a-zA-Z0-9._-]*$

ResetDisabled

remover o botão de redefinição do painel incorporado. O padrão é FALSE, que ativa o botão de redefinição.

SessionLifetimeInMinutes

por quantos minutos a sessão é válida. O tempo de vida da sessão deve ser de 15 a 600 minutos.

Intervalo válido: Valor mínimo de 15. Valor máximo de 600.

StatePersistenceEnabled

Adiciona persistência de estado para a sessão do usuário em um painel incorporado. A persistência se aplica à planilha e às configurações dos parâmetros. Essas são as configurações de controle que o assinante do painel (Amazon QuickSight reader) escolhe ao visualizar o painel. Se estiver definido comoTRUE, as configurações são as mesmas quando o assinante reabre a mesma URL do painel. O estado está armazenado na Amazon (Amazon. QuickSight, não em um cookie de navegador. Se isso for definido como FALSE, o estado da sessão do usuário não será persistido. O padrão é FALSE.

UndoRedoDisabled

remover o botão de desfazer/refazer do painel incorporado. O padrão é FALSE, que ativa o botão desfazer/refazer.

UserArn

O Amazon (Amazon QuickSight Nome de recurso da Amazon (ARN (ARN) do usuário.QUICKSIGHTtipo de identidade. Você pode usar isso para qualquer Amazon. QuickSight os usuários da sua conta (leitores, autores ou administradores) autenticados como uma das seguintes opções:

  • Usuários ou membros do grupo do Active Directory (AD)

  • Usuários não federados convidados

  • As sessões baseadas em funções e usuários do IAM autenticadas por meio de logon único federado com o SAML, o OpenID Connect ou a federação do IAM.

Omitir esse parâmetro para usuários no terceiro grupo — usuários do IAM e sessões baseadas em função do IAM.

Corpo da solicitação

Essa solicitação não tem o corpo da solicitação.

Sintaxe da resposta

HTTP/1.1 Status
Content-type: application/json

{
   "EmbedUrl": "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.

EmbedUrl

Um URL de uso único que você pode colocar em sua página da Web do lado do servidor para incorporar seu painel. Esse URL é válido por 5 minutos. A operação da API fornece ao URL umauth_codevalor que permite um (e somente um) logon em uma sessão de usuário válida por 10 horas.

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.

AccessDeniedException

Você não tem acesso a este item. Não foi possível validar as credenciais fornecidas. Talvez você não tenha permissão para executar a solicitação. Verifique se sua conta está autorizada a usar a Amazon QuickSight se as suas políticas têm as permissões corretas e se você está usando as chaves de acesso corretas.

Código de status HTTP: 401

DomainNotWhitelistedException

O domínio especificado não está na lista de permissões. Todos os domínios para painéis incorporados devem ser adicionados à lista aprovada por uma Amazon QuickSight admin.

Código de status HTTP: 403

IdentityTypeNotSupportedException

O tipo de identidade especificado não é compatível. Os tipos de identidade compatíveis incluemIAMeQUICKSIGHT.

Código de status HTTP: 403

InternalFailureException

Ocorreu um erro interno.

Código de status HTTP: 500

InvalidParameterValueException

Um ou mais parâmetros têm um valor que não é válido.

Código de status HTTP: 400

QuickSightUserNotFoundException

O usuário com o nome fornecido não foi encontrado. Esse erro pode acontecer em qualquer operação que exija encontrar um usuário com base em um nome de usuário fornecido, comoDeleteUser,DescribeUser, e assim por diante.

Código de status HTTP: 404

ResourceExistsException

O recurso especificado já existe.

Código de status HTTP: 409

ResourceNotFoundException

Não foi possível encontrar um ou mais recursos.

Código de status HTTP: 404

SessionLifetimeInMinutesInvalidException

O número de minutos especificado para o tempo de vida de uma sessão não é válido. O tempo de vida da sessão deve ser de 15 a 600 minutos.

Código de status HTTP: 400

ThrottlingException

O acesso é limitado.

Código de status HTTP: 429

UnsupportedPricingPlanException

Esse erro indica que você está chamando uma operação de incorporação na Amazon QuickSightsem o plano de preços exigido em seuAWSconta. Antes que você possa usar a incorporação para usuários anônimos, um QuickSight administrador precisa adicionar definição de preço de capacidade à Amazon QuickSight. Isso pode ser feito naGerenciar Amazon QuickSight.

Depois que o preço da capacidade for adicionado, você poderá usar o GetDashboardEmbedUrl Operação da API com o--identity-type ANONYMOUSopção.

Código de status HTTP: 403

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 Amazon Amazon QuickSight No momento, 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: