Spec-Zone.ru › AWS CLI v2

[ aws . marketplace-reporting ]

get-buyer-dashboard

Описание

Генерирует URL-адрес вставки для панели управления Amazon QuickSight для анонимного пользователя.

Примечание

Этот API доступен только для учётных записей управления организациями Amazon Web Services или делегированных администраторов, зарегистрированных для функции insights по закупкам (procurement-insights.marketplace.amazonaws.com).

Следующие правила применяются к сгенерированному URL:

  • Он содержит временный токен bearer, действительный в течение 5 минут после его генерации. После использования в течение этого периода, он больше не может быть повторно использован.
  • Срок действия сессии составляет один час. Период действия в 5 минут проходит отдельно от срока действия сессии.

См. также: документацию AWS API

Синтаксис

  get-buyer-dashboard
--dashboard-identifier <value>
--embedding-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]

Параметры

--dashboard-identifier (строка)

ARN запрошенной панели управления.

--embedding-domains (список)

Полные доменные имена, которые вы добавляете в разрешённый список для доступа к сгенерированному URL-адресу, который затем вставляется. Вы можете указать до двух доменов или поддоменов в каждом вызове API. Для включения всех поддоменов под определённым доменом используйте * . Например, https://*.amazon.com включает все поддомены под https://aws.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 (логическое значение)

Включить отладку логирования.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определённого профиля из файла ключей.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Ключи не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (логическое значение)

Отключить кли-паджер для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров ввода CLI.

Вывод

embedUrl -> (строка)

URL-адрес вставки панели управления.

dashboardIdentifier -> (строка)

ARN возвращённой панели управления.

embeddingDomains -> (список)

Полные доменные имена, указанные в запросе. Домены обеспечивают доступ к сгенерированному URL-адресу, который затем вставляется. Вы можете указать до двух доменов или поддоменов в каждом вызове API. Для включения всех поддоменов под определённым доменом используйте * . Например, https://*.amazon.com включает все поддомены под https://aws.amazon.com .

(строка)

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API