generate-embed-url-for-registered-user-with-identity

Описание

Генерирует URL-адрес для встраивания опыта Amazon QuickSight на вашем веб-сайте. Данное действие может быть использовано для любого зарегистрированного пользователя в учетной записи Amazon QuickSight, использующей IAM Identity Center для аутентификации. Для этого API требуются сессии IAM Role с усиленной аутентификацией для аутентифицированного пользователя, для которого выполняется вызов API.

Это API использует передачу доверенной идентификации для обеспечения аутентификации конечного пользователя и получения URL-адреса для встраивания, специфичного для этого пользователя. Приложение IAM Identity Center, в которое вошёл пользователь, должно иметь включённую передачу доверенной идентификации для Amazon QuickSight со значением области quicksight:read . Перед использованием этого действия убедитесь, что вы настроили соответствующий ресурс и разрешения Amazon QuickSight.

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

Синопсис

  generate-embed-url-for-registered-user-with-identity
--aws-account-id <value>
[--session-lifetime-in-minutes <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 (целое число)

--experience-configuration (структура)

Синтаксис JSON:

{
  "Dashboard": {
    "InitialDashboardId": "string",
    "FeatureConfigurations": {
      "StatePersistence": {
        "Enabled": true|false
      },
      "SharedView": {
        "Enabled": true|false
      },
      "Bookmarks": {
        "Enabled": true|false
      },
      "AmazonQInQuickSight": {
        "ExecutiveSummary": {
          "Enabled": true|false
        }
      },
      "Schedules": {
        "Enabled": true|false
      },
      "RecentSnapshots": {
        "Enabled": true|false
      },
      "ThresholdAlerts": {
        "Enabled": true|false
      }
    }
  },
  "QuickSightConsole": {
    "InitialPath": "string",
    "FeatureConfigurations": {
      "StatePersistence": {
        "Enabled": true|false
      },
      "SharedView": {
        "Enabled": true|false
      },
      "AmazonQInQuickSight": {
        "DataQnA": {
          "Enabled": true|false
        },
        "GenerativeAuthoring": {
          "Enabled": true|false
        },
        "ExecutiveSummary": {
          "Enabled": true|false
        },
        "DataStories": {
          "Enabled": true|false
        }
      },
      "Schedules": {
        "Enabled": true|false
      },
      "RecentSnapshots": {
        "Enabled": true|false
      },
      "ThresholdAlerts": {
        "Enabled": true|false
      }
    }
  },
  "QSearchBar": {
    "InitialTopicId": "string"
  },
  "DashboardVisual": {
    "InitialDashboardVisualId": {
      "DashboardId": "string",
      "SheetId": "string",
      "VisualId": "string"
    }
  },
  "GenerativeQnA": {
    "InitialTopicId": "string"
  }
}

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

Синтаксис:

"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 -> (строка)

Status -> (целое число)

RequestId -> (строка)