GetSessionEmbedUrl -

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

GetSessionEmbedUrl

Genera una URL de sesión y un código de autorización que puede utilizar para incrustar la consola de Amazon QuickSight en el código del servidor web. UsarGetSessionEmbedUrlEn la que desea proporcionar un portal de creación que permita a los usuarios crear orígenes de datos, conjuntos de datos, análisis y paneles. Los usuarios que acceden a una consola de QuickSight integrada deben pertenecer a la cohorte de seguridad de autor o administrador. Si desea restringir los permisos a algunas de estas características, agregue un perfil de permisos personalizado al usuario con la opción UpdateUser Operación de API. Usar RegisterUser operación de API para agregar un nuevo usuario con un perfil de permisos personalizado adjunto. Para obtener más información, consulte las siguientes secciones de laGuía del usuario de Amazon QuickSight:

Sintaxis de la solicitud

GET /accounts/AwsAccountId/session-embed-url?entry-point=EntryPoint&session-lifetime=SessionLifetimeInMinutes&user-arn=UserArn HTTP/1.1

Parámetros de solicitud URI

La solicitud utiliza los siguientes parámetros URI.

AwsAccountId

El ID de la cuenta de AWS asociada a su suscripción a QuickSight.

Restricciones: Longitud fija de 12.

Patrón: ^[0-9]{12}$

: obligatorio Sí

EntryPoint

La dirección URL que utiliza para acceder a la sesión incrustada. La dirección URL del punto de entrada está restringida a las siguientes rutas:

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId - dondeDashboardIdes la clave de identificación real de la URL de la consola de QuickSight del panel

  • /analyses/AnalysisId - dondeAnalysisIdes la clave de ID real de la URL de la consola de QuickSight del análisis

Restricciones: Longitud mínima de 1. Longitud máxima: 1000 caracteres.

sessionLifeTimeInMinutes

¿Cuántos minutos es válida la sesión. La vida útil de la sesión debe ser un valor comprendido entre 15-600 minutos

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

UserArn

El nombre de recurso de Amazon (ARN) del usuario de Amazon QuickSight, para usar conQUICKSIGHTTipo de identidad. Puede utilizarlo para cualquier tipo de usuarios de Amazon QuickSight en su cuenta (lectores, autores o administrativos). Deben autenticarse como una de las siguientes políticas:

  1. Usuarios o miembros de grupos de Active Directory (AD)

  2. Usuarios no federados invitados

  3. Usuarios de AWS Identity and Access Management (IAM) y sesiones basadas en roles de IAM autenticadas a través de Inicio de sesión único federado con SAML, OpenID Connect o federación IAM

Omita este parámetro para los usuarios del tercer grupo, los usuarios de IAM y las sesiones basadas en roles de IAM.

Cuerpo de la solicitud

La solicitud no tiene un cuerpo de la solicitud.

Sintaxis de la respuesta

HTTP/1.1 Status Content-type: application/json { "EmbedUrl": "string", "RequestId": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve la respuesta HTTP siguiente.

Estado

El estado HTTP de la solicitud.

El servicio devuelve los datos siguientes en formato JSON.

EmbedURL

Una dirección URL de un solo uso que puede incluir en la página web del servidor para incrustar la sesión de QuickSight. Esta URL es válida durante 5 minutos. La operación API proporciona a la URL unauth_codeque habilita un inicio de sesión (y sólo uno) en una sesión de usuario válida durante 10 horas.

Tipo: Cadena

RequestId

ID de solicitud de AWS de esta operación.

Tipo: Cadena

Errors

Para obtener información sobre errores que son comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

No tiene permiso de acceso. La credenciales proporcionadas no se pudieron validar. Es posible que no tenga autorización para realizar la solicitud. Asegúrese de que su cuenta tiene permiso para utilizar el servicio de Amazon QuickSight, que las políticas tienen los permisos correctos y que está utilizando las claves de acceso correctas.

Código de estado HTTP: 401

InternalFailureException

Se produjo un error interno.

Código de estado HTTP: 500

InvalidParameterValueException

Uno o más parámetros tienen un valor que no es válido.

Código de estado HTTP: 400

QuickSightUserNotFoundException

No se encuentra el usuario con el nombre proporcionado. Este error puede ocurrir en cualquier operación que requiera la búsqueda de un usuario en función de un nombre de usuario proporcionado, comoDeleteUser,DescribeUser, y así sucesivamente.

Código de estado HTTP: 404

ResourceExistsException

El recurso especificado ya existe.

Código de estado HTTP: 409

ResourceNotFoundException

No se encontraron uno o varios recursos.

Código de estado HTTP: 404

SessionLifetimeInMinutesInvalidException

El número de minutos especificado para la vida útil de una sesión no es válido. La vida útil de la sesión debe ser un valor comprendido entre 15-600 minutos

Código de estado HTTP: 400

ThrottlingException

El acceso está limitado.

Código de estado HTTP: 429

UnsupportedUserEditionException

Este error indica que está llamando a una operación en una suscripción de Amazon QuickSight en la que la edición no admite esa operación. Las ediciones actuales de Amazon QuickSight son Standard Edition y Enterprise Edition. No todas las operaciones y funciones están disponibles en todas las ediciones.

Código de estado HTTP: 403

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: