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.
GenerateEmbedUrlForAnonymousUser
Genera una URL de inserción que puedes usar para insertar un Amazon QuickSight panel de control en su sitio web, sin tener que registrar ningún usuario lector. Antes de utilizar esta acción, asegúrese de haber configurado los paneles de y permisos de.
Las siguientes reglas se aplican a la URL generada:
-
Contiene un token de portador temporal. Es válido durante 5 minutos después de su generación. Una vez canjeado dentro de este período, no se puede volver a utilizar.
-
El período de validez de la URL no debe confundirse con la duración real de la sesión, que se puede personalizar mediante la
SessionLifetimeInMinutesparámetro de La sesión de usuario resultante es válida durante 15 minutos (mínimo) a 10 horas (máximo). La duración predeterminada de la sesión de es de 10 horas. -
Solo se te cobrará cuando se utilice la URL o haya interacción con Amazon QuickSight.
Para obtener más información, consulteAnálisis incrustadosen 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
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 de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- AwsAccountId
-
El ID de ID de:Cuenta de AWSque contiene el panel que va a insertar.
Limitaciones de longitud Longitud fija de 12 caracteres de
Patrón:
^[0-9]{12}$Obligatorio: Sí
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- AuthorizedResourceArns
-
Nombres de recursos de Amazon (ARN) para Amazon QuickSight recursos a los que el usuario está autorizado a acceder durante la duración de la sesión. Si elige
Dashboardexperiencia de incrustación, pase la lista de ARN del panel de control en la cuenta que desea que el usuario pueda ver. Actualmente, puedes pasar hasta 25 ARN de panel en cada llamada a la API.Type: Matriz de cadenas
Obligatorio: Sí
- ExperienceConfiguration
-
La configuración de la experiencia que va a integrar.
Tipo: objeto AnonymousUserEmbeddingExperienceConfiguration
Obligatorio: Sí
- Namespace
-
Amazon QuickSight espacio de nombres al que pertenece virtualmente el usuario anónimo. Si no utilizas Amazon QuickSight espacio de nombres personalizado, establézcalo en
default.Type: Cadena
Limitaciones de longitud La longitud máxima es 64.
Patrón:
^[a-zA-Z0-9._-]*$Obligatorio: Sí
- AllowedDomains
-
Los dominios que desea agregar a la lista de permitidos para acceder a la URL generada que luego se incrusta. Este parámetro opcional anula los dominios estáticos que se configuran en Administrar QuickSight menú en el Amazonas QuickSight consola de . En cambio, solo permite los dominios que se incluyen en este parámetro. Puedes enumerar hasta tres dominios o subdominios en cada llamada a la API.
Para incluir todos los subdominios de un dominio específico en la lista de permitidos, usa
*. Por ejemplo,https://*.sapp.amazon.comincluye todos los subdominios enhttps://sapp.amazon.com.Type: Matriz de cadenas
Obligatorio: No
- 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 600 minutos.
Type: Largo
Rango válido: Valor mínimo de 15 caracteres de Valor máximo de 600.
Obligatorio: No
- SessionTags
-
Las etiquetas de sesión utilizadas para seguridad de nivel de fila de Antes de utilizar este parámetro, compruebe que ha configurado los conjuntos de datos pertinentes mediante la
DataSet$RowLevelPermissionTagConfigurationpara que las etiquetas de sesión se puedan usar para proporcionar seguridad a nivel de fila.Estas no son las etiquetas que se utilizan paraAWSfunción de Etiquetado de recursos de Para obtener más información, consulteUso de seguridad de nivel de fila (RLS) con etiquetasen laAmazon QuickSight Guía del usuario de.
Type: Array deSessionTagobjects
Miembros de la matriz: Número mínimo de 1 elemento de Número máximo de 50 elementos.
Obligatorio: No
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.
Errores
Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.
- AccessDeniedException
-
No tiene permiso de acceso a este elemento. La credenciales proporcionadas no se pudieron validar. Es posible no tenga autorización para realizar la solicitud de Asegúrese de que su cuenta esté autorizada para usar 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
- 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 de 15 a 600 minutos.
Código de estado HTTP: 400
- ThrottlingException
-
El acceso está limitado.
Código de estado 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 laManage Amazon QuickSight(Se ha creado el certificado).
Una vez añadidos los precios de capacidad, puede usar el
GetDashboardEmbedUrlOperación de API de--identity-type ANONYMOUSopción.Código de estado 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 QuickSight actualmente tiene 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:
