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 usar para incrustar Amazon Amazon QuickSight en el código de su servidor web. UsarGetSessionEmbedUrldonde desea proporcionar un portal de creación que permita a los usuarios de crear orígenes de datos, conjuntos de datos, análisis y paneles. Los usuarios que acceden a un Amazon integrado QuickSight la consola debe pertenecer a la cohorte de seguridad de autor o administrador. Si desea restringir los permisos a algunas de estas funciones, añada un perfil de permisos personalizado al usuario con la
UpdateUser
Operación de la API. Usar
RegisterUser
Operación de API para añadir un nuevo usuario con un perfil de permisos personalizado adjunto. Para obtener más información, consulte las siguientes secciones de laAmazon QuickSight Guía del usuario de:
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 del URI
La solicitud utiliza los siguientes parámetros URI.
- AwsAccountId
-
El ID deCuenta de AWSasociado a su Amazon QuickSight suscripción.
Restricciones de longitud Longitud fija de 12 caracteres.
Patrón:
^[0-9]{12}$Obligatorio: Sí
- EntryPoint
-
La URL que utiliza para acceder a la sesión incrustada. La URL del punto de entrada está restringida a las siguientes rutas:
-
/start -
/start/analyses -
/start/dashboards -
/start/favorites -
/dashboards/DashboardId- dondeDashboardIdes la clave de ID en sí de Amazon QuickSight URL de consola del panel -
/analyses/AnalysisId- dondeAnalysisIdes la clave de ID en sí de Amazon QuickSight URL de la consola del análisis
Restricciones de longitud Longitud mínima de 1. La longitud máxima es de 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 y
Rango válido: Valor mínimo de 15. Valor máximo de 600.
- UserArn
-
El Amazon QuickSight El nombre de recurso de Amazon (ARN) del usuario, para su uso con
QUICKSIGHTtipo de identidad. Puedes usarlo para cualquier tipo de Amazon QuickSight usuarios de su cuenta (lectores, autores o administradores). Se deben autenticar como una de las siguientes políticas:-
Usuarios o miembros de grupos de Active Directory (AD)
-
Usuarios no federados invitados
-
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 IAM federated Single Sign-On
Omita este parámetro para los usuarios del tercer grupo, los usuarios de IAM y las sesiones basadas en funciones 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 siguiente respuesta HTTP.
- Status
-
El estado HTTP de la solicitud.
El servicio devuelve los datos siguientes en formato JSON.
- EmbedUrl
-
Una URL de un solo uso que puedes poner en tu página web del lado del servidor para insertar tu Amazon QuickSight sesión. Esta URL es válida durante 5 minutos. La operación de la API proporciona a la URL un
auth_codeque permite un inicio de sesión (y solo uno) en una sesión de usuario válida durante 10 horas.Type: Cadena
- RequestId
-
LaAWSID de solicitud de esta operación.
Type: Cadena
Errores
Para obtener información sobre los 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 esté autorizada para usar Amazon QuickSight , que sus 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 del nombre de usuario proporcionado, como
DeleteUser,DescribeUser,, yCó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 y
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 Amazon QuickSighten la que la edición no incluye soporte para esa operación. Amazon Amazon QuickSight tiene las ediciones actuales de 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:
