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á. # GetSessionEmbedUrl Gera um URL de sessão e um código de autorização que você pode usar para incorporar a Amazon Amazon QuickSight no código do servidor da web. Usar o`GetSessionEmbedUrl`onde você deseja fornecer um portal de criação que permite aos usuários criar fontes de dados, análises e painéis. Os usuários que acessam uma Amazon incorporada QuickSight o console precisa pertencer à coorte de segurança do autor ou administrador. Se você quiser restringir as permissões a alguns desses recursos, adicione um perfil de permissões personalizado ao usuário com a` [UpdateUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) `Operação da API do. Usar o` [RegisterUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html) `Operação de API para adicionar um novo usuário com um perfil de permissão personalizado anexado. Para obter mais informações, consulte as seções a seguir no*Amazônia QuickSight Guia do usuário do*: + [Incorporação de análises de](https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html) + [Personalizando o acesso à Amazon QuickSight Console do](https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html) ## Sintaxe da solicitação ``` GET /accounts/AwsAccountId/session-embed-url?entry-point=EntryPoint&session-lifetime=SessionLifetimeInMinutes&user-arn=UserArn HTTP/1.1 ``` ## Parâmetros da solicitação de URI A solicitação usa os parâmetros de URI a seguir. ** [AwsAccountId](#API_GetSessionEmbedUrl_RequestSyntax) ** O ID do doConta da AWSassociado a sua Amazon QuickSight assinatura. Restrições de tamanho: Comprimento fixo de 12. Padrão: `^[0-9]{12}$` Obrigatório: Sim ** [EntryPoint](#API_GetSessionEmbedUrl_RequestSyntax) ** O URL que você usa para acessar a sessão incorporada. A URL do ponto de entrada está restrita aos seguintes caminhos: + `/start` + `/start/analyses` + `/start/dashboards` + `/start/favorites` + `/dashboards/DashboardId `- onde`DashboardId`é a chave de ID real da Amazon. QuickSight URL do console do painel + `/analyses/AnalysisId `- onde`AnalysisId`é a chave de ID real da Amazon. QuickSight URL do console da análise da análise. Restrições de tamanho: Tamanho mínimo de 1. Tamanho máximo de 1000. ** [SessionLifetimeInMinutes](#API_GetSessionEmbedUrl_RequestSyntax) ** por quantos minutos a sessão é válida. O tempo de vida da sessão deve estar a 15 a 600 minutos. Intervalo válido: Valor mínimo de 15. Valor máximo de 600. ** [UserArn](#API_GetSessionEmbedUrl_RequestSyntax) ** A Amazon QuickSight Nome de recurso da Amazon (ARN) do usuário, para uso com o nome do recurso da Amazon`QUICKSIGHT`tipo de identidade. Você pode usar isso para qualquer tipo de Amazon QuickSight usuários em sua conta (leitores, autores ou administradores). Eles precisam ser autenticadas como uma das seguintes opções: 1. Usuários ou membros do grupo do Active Directory (AD) 1. Usuários não federados convidados. 1. AWS Identity and Access Management(IAM) e usuários do SAML, o OpenID Connect ou a federação do 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](#API_GetSessionEmbedUrl_ResponseSyntax) ** O status HTTP da solicitação. Os seguintes dados são retornados no formato JSON pelo serviço. ** [EmbedUrl](#API_GetSessionEmbedUrl_ResponseSyntax) ** Um URL de uso único que você pode colocar em sua página da web do lado do servidor para incorporar sua Amazon QuickSight session. Esse URL é válido por 5 minutos. A operação da API fornece ao URL um`auth_code`valor que permite um (e somente um) logon em uma sessão de usuário válida por 10 horas. Type: String ** [RequestId](#API_GetSessionEmbedUrl_ResponseSyntax) ** 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](CommonErrors.md). ** 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 , 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 ** 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, como`DeleteUser`,`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 estar a 15 a 600 minutos. Código de status HTTP: 400 ** 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 No momento, a 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: + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/GetSessionEmbedUrl) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/GetSessionEmbedUrl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/GetSessionEmbedUrl) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/GetSessionEmbedUrl) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/GetSessionEmbedUrl) + [AWSSDK para o JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/GetSessionEmbedUrl) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/GetSessionEmbedUrl) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/GetSessionEmbedUrl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/GetSessionEmbedUrl)