GetDashboardEmbedUrl - Amazon QuickSight

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.

GetDashboardEmbedUrl

Genera una URL de sesión temporal y un código de autorización (token de portador) que puede usar para insertar un Amazon QuickSight panel de solo lectura en su sitio web o aplicación. Antes de utilizar este comando, asegúrese de que ha configurado los paneles de y los permisos.

En la actualidad puede utilizarGetDashboardEmbedURLsolo desde el servidor, no desde el navegador del usuario. Las siguientes reglas se aplican a la URL generada:

  • Deben utilizarse de forma conjunta.

  • Solo se pueden usar una vez.

  • Son válidos durante 5 horas después de la operación.

  • Solo se te cobrará cuando se utilice la URL o haya interacción con Amazon QuickSight.

  • La sesión de usuario resultante es válida durante 15 minutos (predeterminado) hasta 10 horas (máximo). Puede utilizar la opción opcional deSessionLifetimeInMinutespara personalizar la duración de la sesión.

Para obtener más información, consulteIntegración de análisis de GetDashboardEmbedUrlen laAmazon QuickSight Guía del usuario de.

Para obtener más información sobre los pasos de alto nivel para la incrustación y para obtener una demostración interactiva de las formas en que puede personalizar la incrustación, visite laAmazon QuickSight Portal para desarrolladores.

Sintaxis de la solicitud

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 de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

AdditionalDashboardIds

Una lista de uno o más ID de panel a los que desea que los usuarios anónimos tengan acceso temporal. En la actualidad, elIdentityTypedebe establecerse enANONYMOUSporque otros tipos de identidad se autentican como Amazon QuickSight o usuarios de IAM. Por ejemplo, si establece»--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS«, la sesión puede acceder a los tres paneles.

Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 20 elementos.

Limitaciones de longitud Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: [\w\-]+

AwsAccountId

El ID de:Cuenta de AWSque contiene el panel que va a insertar.

Limitaciones de longitud Limitado longitud de 12 caracteres.

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

Obligatorio: Sí

DashboardId

El ID del panel de control, que también se ha añadido a laAWS Identity and Access ManagementPolítica de (IAM).

Limitaciones de longitud Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: [\w\-]+

Obligatorio: Sí

IdentityType

El método de autenticación que utiliza el usuario para iniciar sesión.

Valores válidos: IAM | QUICKSIGHT | ANONYMOUS

Obligatorio: Sí

Namespace

El Amazon QuickSight espacio de nombres que contiene los ID del panel de esta solicitud. Si no usas un espacio de nombres personalizado, estableceNamespace = default.

Limitaciones de longitud La longitud máxima es 64.

Patrón: ^[a-zA-Z0-9._-]*$

ResetDisabled

Quite el botón de restablecer en el panel integrado. El valor predeterminado es FALSE, que activa el botón de reinicio.

SessionLifetimeInMinutes

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

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

StatePersistenceEnabled

Añade persistencia de estado para la sesión del usuario en un panel integrado. La persistencia se aplica a la hoja y a la configuración de los parámetros. Estos son los ajustes de control que el suscriptor del panel (Amazon QuickSight lector) elige mientras ve el tablero. Si se establece enTRUE, la configuración es la misma cuando el suscriptor vuelve a abrir la misma URL del panel. El estado se almacena en Amazon. QuickSight, no en una cookie del navegador. Si se establece en FALSE, el estado de la sesión del usuario no se conserva. El valor predeterminado es FALSE.

UndoRedoDisabled

Quite el botón deshacer/rehacer en el panel integrado. El valor predeterminado es FALSE, que habilita el botón deshacer/rehacer.

UserArn

El Amazon QuickSight Nombre de recurso de Amazon (ARN) del usuario, para utilizar conQUICKSIGHTtipo de identidad. Puede utilizar esta operación para cualquier Amazon QuickSight usuarios de su cuenta de (lectores, autores o administrativos) autenticados como uno de los siguientes:

  • Usuarios o miembros de grupos de Active Directory (AD)

  • Usuarios no federados invitados

  • Usuarios de 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.

Omita este parámetro para los usuarios del tercer grupo: usuarios de IAM y 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 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 incrustar tu panel. Esta URL es válido durante 5 minutos. La operación de la API proporciona a la URL unauth_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 para esta operación.

Type: Cadena

Errores

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 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 HTTP: 401

DomainNotWhitelistedException

El dominio especificado no está en la lista de permitidos. Un Amazon debe añadir todos los dominios de los paneles integrados a la lista de dominios aprobados QuickSight admin.

Código de estado HTTP HTTP: 403

IdentityTypeNotSupportedException

No se admite el tipo de identidad especificado no se admite. Los tipos de identidad admitidos incluyenIAMyQUICKSIGHT.

Código de estado HTTP HTTP: 403

InternalFailureException

Se produjo un error interno.

Código de estado HTTP HTTP: 500

InvalidParameterValueException

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

Código de estado HTTP 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 HTTP: 404

ResourceExistsException

El recurso especificado ya existe.

Código de estado HTTP HTTP: 409

ResourceNotFoundException

No se encuentran uno o varios recursos.

Código de estado HTTP HTTP: 404

SessionLifetimeInMinutesInvalidException

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

Código de estado HTTP HTTP: 400

ThrottlingException

El acceso está limitado.

Código de estado HTTP HTTP: 429

UnsupportedPricingPlanException

Este error indica que estás llamando a una operación de incrustación en Amazon QuickSightsin el plan de precios exigido en tuAWSaccount. Antes de poder usar la incrustación para usuarios anónimos, se debe QuickSight el administrador necesita añadir precios por capacidad a Amazon QuickSight. Puede hacer esto en la página deAdministrar Amazon QuickSight(Se ha creado el certificado).

Una vez añadidos los precios de capacidad, puede usar el GetDashboardEmbedUrl Operación de la API con el--identity-type ANONYMOUSopción.

Código de estado HTTP HTTP: 403

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 Amazon QuickSight tiene Standard Edition y Enterprise Edition. No todas las operaciones y funciones están disponibles en todas las ediciones.

Código de estado HTTP 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: