создание-подписки-на-аккаунт

Описание

Создает учетную запись Amazon QuickSight или подписывается на Amazon QuickSight Q.

Регион Amazon Web Services для учетной записи определяется по конфигурации в CLI или SDK.

Перед использованием этой операции убедитесь, что вы можете подключиться к существующей учетной записи Amazon Web Services. Если у вас нет учетной записи Amazon Web Services, см. раздел «Регистрация в Amazon Web Services» в Руководстве пользователя Amazon QuickSight. Человек, регистрирующийся в Amazon QuickSight, должен иметь соответствующие разрешения Identity and Access Management (IAM). Дополнительную информацию см. в разделе «Примеры политик IAM для Amazon QuickSight» в Руководстве пользователя Amazon QuickSight.

Если ваша политика IAM включает оба действия Subscribe и CreateAccountSubscription, убедитесь, что оба действия установлены в значение Allow. Если какое-либо из действий установлено в Deny, действие Deny превалирует, и ваш вызов API завершится неудачно.

Вы не можете передать существующую роль IAM для доступа к другим службам Amazon Web Services с помощью данной операции API. Чтобы передать существующую роль IAM в Amazon QuickSight, см. раздел «Передача ролей IAM в Amazon QuickSight» в Руководстве пользователя Amazon QuickSight.

Вы не можете установить параметры доступа к ресурсам по умолчанию для новой учетной записи через API Amazon QuickSight. Вместо этого добавьте параметры доступа к ресурсам по умолчанию через консоль Amazon QuickSight. Дополнительную информацию об установке параметров доступа к ресурсам по умолчанию к службам Amazon Web Services см. в разделе «Установка параметров доступа к ресурсам по умолчанию к службам Amazon Web Services» в Руководстве пользователя Amazon QuickSight.

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

Синтаксис

  create-account-subscription
[--edition <value>]
--authentication-method <value>
--aws-account-id <value>
--account-name <value>
--notification-email <value>
[--active-directory-name <value>]
[--realm <value>]
[--directory-id <value>]
[--admin-group <value>]
[--author-group <value>]
[--reader-group <value>]
[--admin-pro-group <value>]
[--author-pro-group <value>]
[--reader-pro-group <value>]
[--first-name <value>]
[--last-name <value>]
[--email-address <value>]
[--contact-number <value>]
[--iam-identity-center-instance-arn <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]

Параметры

--edition (строка)

--authentication-method (строка)

--aws-account-id (строка)

--account-name (строка)

--notification-email (строка)

--active-directory-name (строка)

--realm (строка)

--directory-id (строка)

--admin-group (список)

Синтаксис:

"string" "string" ...

--author-group (список)

Синтаксис:

"string" "string" ...

--reader-group (список)

Синтаксис:

"string" "string" ...

--admin-pro-group (список)

Синтаксис:

"string" "string" ...

--author-pro-group (список)

Синтаксис:

"string" "string" ...

--reader-pro-group (список)

Синтаксис:

"string" "string" ...

--first-name (строка)

--last-name (строка)

--email-address (строка)

--contact-number (строка)

--iam-identity-center-instance-arn (строка)

--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.

Вывод

SignupResponse -> (структура)

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

RequestId -> (строка)