[ aws . quicksight ]
generate-embed-url-for-anonymous-user
Описание
Генерирует URL для встраивания, который можно использовать для встраивания панели мониторинга или визуализации Amazon QuickSight на вашем веб-сайте без регистрации пользователей-читателей. Перед использованием этого действия убедитесь, что панели мониторинга и разрешения настроены.
Для сгенерированного URL применяются следующие правила:
- Он содержит временный токен доступа. Он действителен в течение 5 минут после его генерации. После использования в течение этого периода он больше не может быть повторно использован.
- Срок действия URL не следует путать со сроком действия сессии, который можно настроить с помощью параметра `` SessionLifetimeInMinutes ``. Результирующая сессия пользователя действительна от 15 минут (минимум) до 10 часов (максимум). По умолчанию продолжительность сессии составляет 10 часов.
- Вы платите только тогда, когда URL используется или происходит взаимодействие с Amazon QuickSight.
Дополнительную информацию см. в разделе «Встроенный анализ» в Руководстве пользователя Amazon QuickSight.
Дополнительную информацию о шагах высокого уровня для встраивания и интерактивную демонстрацию способов настройки встраивания см. на портале разработчиков Amazon QuickSight.
См. также: Документация API AWS
Синтаксис
generate-embed-url-for-anonymous-user
--aws-account-id <value>
[--session-lifetime-in-minutes <value>]
--namespace <value>
[--session-tags <value>]
--authorized-resource-arns <value>
--experience-configuration <value>
[--allowed-domains <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--aws-account-id (строка)
--session-lifetime-in-minutes (длинное целое число)
--namespace (строка)
default.--session-tags (список)
Теги сессии, используемые для защиты на уровне строк. Перед использованием этого параметра убедитесь, что соответствующие наборы данных настроены с использованием параметра DataSet$RowLevelPermissionTagConfiguration, чтобы теги сессии могли использоваться для обеспечения защиты на уровне строк.
Это не теги, используемые для маркировки ресурсов Amazon Web Services. Дополнительную информацию см. в разделе «Использование защиты на уровне строк (RLS) с тегами» в Руководстве пользователя Amazon QuickSight.
(структура)
Пара ключ-значение, используемая для функции тегов защиты на уровне строк.
Ключ -> (строка)
Значение -> (строка)
Сокращённый синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--authorized-resource-arns (список)
Amazon Resource Names (ARN) ресурсов Amazon QuickSight, к которым пользователь имеет право доступа в течение срока действия сессии.
Если вы выбираете опыт встраивания Dashboard, передайте список ARN панелей мониторинга в учетной записи, которые вы хотите, чтобы пользователь мог просматривать.
Если вы хотите изменить тему встраиваемого контента, передайте список ARN тем, к которым анонимные пользователи должны иметь доступ.
В настоящее время вы можете передать до 25 ARN тем в каждом вызове API.
(строка)
Синтаксис:
"string" "string" ...
--experience-configuration (структура)
Настройка опыта, который вы встраиваете.
Панель мониторинга -> (структура)
Тип опыта встраивания. В данном случае, панели мониторинга Amazon QuickSight.
InitialDashboardId -> (строка)
Идентификатор панели мониторинга для панели мониторинга, которую вы хотите, чтобы пользователь увидел первым. Этот идентификатор включён в выходной URL. При доступе к URL в ответе Amazon QuickSight отображает эту панель мониторинга.
Amazon Resource Name (ARN) этой панели мониторинга должен быть включён в параметр AuthorizedResourceArns. В противном случае запрос завершится с ошибкой InvalidParameterValueException.
EnabledFeatures -> (список)
Список всех включенных функций указанной анонимной панели мониторинга.
(строка)
DisabledFeatures -> (список)
Список всех отключенных функций указанной анонимной панели мониторинга.
(строка)
FeatureConfigurations -> (структура)
Настройка функций для встроенной панели мониторинга.
SharedView -> (структура)
Настройки совместного просмотра встроенной панели мониторинга.
Enabled -> (булево)
DashboardVisual -> (структура)
Тип опыта встраивания. В данном случае, визуализации Amazon QuickSight.
InitialDashboardVisualId -> (структура)
Идентификатор визуализации для визуализации, которую вы хотите, чтобы пользователь увидел. Этот идентификатор включён в выходной URL. При доступе к URL в ответе Amazon QuickSight отображает эту визуализацию.
Amazon Resource Name (ARN) панели мониторинга, к которой принадлежит визуализация, должен быть включён в параметр AuthorizedResourceArns. В противном случае запрос завершится с ошибкой InvalidParameterValueException.
DashboardId -> (строка)
DashboardId можно найти в разделе IDs for developers панели Embed visual визуализации в консоли Amazon QuickSight. Вы также можете получить DashboardId с помощью операции API ListDashboards.SheetId -> (строка)
SheetId можно найти в разделе IDs for developers панели Embed visual визуализации в консоли Amazon QuickSight.VisualId -> (строка)
VisualID можно найти в разделе IDs for developers панели Embed visual визуализации в консоли Amazon QuickSight.QSearchBar -> (структура)
Поисковая строка Q, которую вы хотите использовать для встраивания анонимного пользователя.
InitialTopicId -> (строка)
Идентификатор темы Amazon QuickSight Q устаревшей темы, которую вы хотите, чтобы анонимный пользователь увидел первым. Этот идентификатор включён в выходной URL. При доступе к URL в ответе Amazon QuickSight отображает поисковую строку Q с предварительно выбранной устаревшей темой.
Amazon Resource Name (ARN) этой устаревшей темы Q должен быть включён в параметр AuthorizedResourceArns. В противном случае запрос завершается ошибкой InvalidParameterValueException.
GenerativeQnA -> (структура)
Опыт Generative Q&A, который вы хотите использовать для встраивания анонимного пользователя.
InitialTopicId -> (строка)
Идентификатор темы Amazon QuickSight Q новой темы для опыта чтения, которую вы хотите, чтобы анонимный пользователь увидел первым. Этот идентификатор включён в выходной URL. При доступе к URL в ответе Amazon QuickSight отображает опыт Generative Q&A с предварительно выбранной новой темой для опыта чтения.
Amazon Resource Name (ARN) этой новой темы для опыта чтения Q должен быть включён в параметр AuthorizedResourceArns. В противном случае запрос завершается ошибкой InvalidParameterValueException.
Синтаксис JSON:
{
"Dashboard": {
"InitialDashboardId": "string",
"EnabledFeatures": ["SHARED_VIEW", ...],
"DisabledFeatures": ["SHARED_VIEW", ...],
"FeatureConfigurations": {
"SharedView": {
"Enabled": true|false
}
}
},
"DashboardVisual": {
"InitialDashboardVisualId": {
"DashboardId": "string",
"SheetId": "string",
"VisualId": "string"
}
},
"QSearchBar": {
"InitialTopicId": "string"
},
"GenerativeQnA": {
"InitialTopicId": "string"
}
}
--allowed-domains (список)
Домены, которые вы хотите добавить в список разрешенных для доступа к сгенерированному URL, который затем будет встроен. Этот необязательный параметр переопределяет статические домены, настроенные в меню «Управление QuickSight» в консоли Amazon QuickSight. Вместо этого он разрешает доступ только тем доменам, которые вы включаете в этот параметр. Вы можете перечислить до трех доменов или поддоменов в каждом вызове API.
Чтобы добавить все поддомены в определённом домене в список разрешенных, используйте *. Например, https://*.sapp.amazon.com включает все поддомены в https://sapp.amazon.com.
(строка)
Синтаксис:
"string" "string" ...
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Передача произвольных двоичных данных с помощью значения, предоставленного в JSON, невозможна, так как строка будет интерпретирована буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернёт пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном каркасе JSON.
Общие параметры
--debug (boolean)
Включить отладку.
--endpoint-url (string)
Переопределить URL команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла аутентификации.
--region (string)
Регион для использования. Переопределяет параметры конфигурации/среды.
--version (string)
Показать версию этого инструмента.
--color (string)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Кредиты не будут загружены, если этот параметр указан.
--ca-bundle (string)
Файл сертификата CA для проверки SSL-сертификатов. Переопределяет параметры конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования двоичных данных. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные данные будут предоставлены в виде закодированной строки base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, относящегося к двоичным данным, fileb:// всегда будет обрабатываться как двоичные данные и будет использовать содержимое файла напрямую, независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для конфигурированного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Отключить паджинг вывода CLI.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
EmbedUrl -> (string)
Status -> (integer)
RequestId -> (string)
AnonymousUserArn -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.