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

GenerateEmbedUrlForAnonymousUser

Gera um URL incorporado que você pode usar para incorporar uma Amazon QuickSight painel no seu site, sem ter que registrar nenhum usuário leitor. Antes de usar essa ação, verifique de ter configurado os painéis e as permissões.

As seguintes regras se aplicam ao URL gerado:

  • Ele contém um token de portador temporário. É válido por 5 minutos após ser gerado. Depois de resgatado dentro desse período, ele não poderá ser reutilizado novamente.

  • O período de validade do URL não deve ser confundido com o tempo de vida real da sessão que pode ser personalizado usando o SessionLifetimeInMinutes parâmetro . A sessão de usuário resultante é válida por 15 minutos (mínimo) a 10 horas (máximo). O padrão, a duração da sessão é de 10 horas.

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

Para obter mais informações, consulteAnálises incorporadasnoAmazô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 de personalizar a incorporação, visite oAmazônia QuickSight Portal do desenvolvedor.

Sintaxe da solicitação

POST /accounts/AwsAccountId/embed-url/anonymous-user HTTP/1.1
Content-type: application/json

{
   "AllowedDomains": [ "string" ],
   "AuthorizedResourceArns": [ "string" ],
   "ExperienceConfiguration": { 
      "Dashboard": { 
         "InitialDashboardId": "string"
      }
   },
   "Namespace": "string",
   "SessionLifetimeInMinutes": number,
   "SessionTags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Parâmetros da solicitação de URI

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

AwsAccountId

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

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

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

obrigatório: obrigatório: Sim

Corpo da solicitação

A solicitação aceita os dados a seguir no formato JSON.

AuthorizedResourceArns

Nomes de recurso da Amazon (ARNs) para a Amazon QuickSight recursos que o usuário está autorizado a acessar durante a duração da sessão. Se escolher escolherDashboardexperiência de incorporação, passe a lista de ARNs do painel na conta que você deseja que o usuário possa visualizar. Atualmente, você pode passar até 25 ARNs de painel em cada chamada de API.

Type: Matriz de strings

obrigatório: obrigatório: Sim

ExperienceConfiguration

A configuração da experiência que você está incorporando.

Tipo: objeto AnonymousUserEmbeddingExperienceConfiguration

obrigatório: obrigatório: Sim

Namespace

A Amazon QuickSight namespace ao qual o usuário anônimo virtualmente pertence. Se você não estiver usando uma Amazon QuickSight namespace personalizado, defina isso comodefault.

Type: String

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

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

obrigatório: obrigatório: Sim

AllowedDomains

Os domínios que você deseja adicionar à lista de permissões para acesso ao URL gerado que é incorporado. Esse parâmetro opcional substitui os domínios estáticos configurados no Gerenciar QuickSight menu na Amazônia QuickSight console do . Em vez disso, ele permite somente os domínios que você incluir nesse parâmetro. Você pode listar até três domínios ou subdomínios em cada chamada de API.

Para incluir todos os subdomínios em um domínio específico na lista de permissões, use*. Por exemplo,https://*.sapp.amazon.com.rproxy.goskope.cominclui todos os subdomínios emhttps://sapp.amazon.com.

Type: Matriz de strings

obrigatório: obrigatório: Não

SessionLifetimeInMinutes

por quantos minutos a sessão é válida. O tempo de vida da sessão deve estar em um intervalo de [15 a 600] minutos.

Type: Longo

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

obrigatório: obrigatório: Não

SessionTags

As Marcações de sessão usadas para segurança em nível de linha. Antes de usar esse parâmetro, certifique-se de ter configurado os conjuntos de dados relevantes usando aDataSet$RowLevelPermissionTagConfigurationpara que as tags de sessão possam ser usadas para fornecer segurança em nível de linha.

Essas não são as tags usadas para oAWSrecurso de Marcação de recursos do. Para obter mais informações, consulteComo usar segurança em nível de linha (RLS) com Marcações de nível de linhanoAmazônia QuickSight Guia do usuário do.

Type: Matriz de deSessionTagobjetos

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

obrigatório: obrigatório: Nã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

O URL incorporado para o painel.

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, consulte:Erros comuns.

AccessDeniedException

Você não tem acesso a esse 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 serviço do, 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

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

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 estar entre 15 e 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 de usar a incorporação para usuários anônimos, um QuickSight administrador precisa adicionar definição de preço de capacidade à Amazon QuickSight. É possível fazer isso no noGerenciar a 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 operação em uma operação em uma Amazon QuickSightassinatura em que a edição não inclui suporte para essa operação. Amazon Amazon QuickSight No momento, tem 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: