[ aws . organizations ]
Приглашение учетной записи в организацию
Описание
Отправляет приглашение другой учетной записи присоединиться к вашей организации в качестве учетной записи-члена. Организация отправляет электронное письмо от вашего имени на адрес электронной почты, связанный с владельцем другой учетной записи. Приглашение реализовано как Handshake, детали которого указаны в ответе.
Предупреждение
- Вы можете приглашать учетные записи Amazon Web Services только от того же продавца, что и учетная запись управления. Например, если учетная запись управления вашей организации была создана Amazon Internet Services Pvt. Ltd (AISPL), продавцом Amazon Web Services в Индии, вы можете приглашать только другие учетные записи AISPL в вашу организацию. Вы не можете объединять учетные записи из AISPL и Amazon Web Services или любого другого продавца Amazon Web Services. Дополнительная информация см. в разделе Объединенный выставление счетов в Индии.
- Если вы получаете исключение, указывающее, что вы превысили лимит учетных записей для организации или что операция не удалась, потому что ваша организация все еще инициализируется, подождите один час, а затем повторите попытку. Если ошибка сохраняется через час, обратитесь в службу поддержки Amazon Web Services.
Если запрос включает теги, у отправителя должны быть соответствующие organizations:TagResource разрешения.
Выполнять эту операцию можно только из учетной записи управления организацией.
См. также: Документация API AWS
Синтаксис
invite-account-to-organization
--target <value>
[--notes <value>]
[--tags <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]
Параметры
--target (структура)
Идентификатор (ID) учетной записи Amazon Web Services, которую вы хотите пригласить в вашу организацию. Это JSON-объект, содержащий следующие элементы:
{ "Type": "ACCOUNT", "Id": "<* **account id number** * >" }Если вы используете командную строку, вы можете отправить это как одну строку, аналогично следующему примеру:
--target Id=123456789012,Type=ACCOUNTЕсли вы указываете "Type": "ACCOUNT" , вы должны указать номер идентификатора учетной записи Amazon Web Services как Id . Если вы указываете "Type": "EMAIL" , вы должны указать адрес электронной почты, связанный с учетной записью.
--target Id=diego@example.com,Type=EMAILId -> (строка)
Уникальный идентификатор (ID) стороны.
Шаблон регулярных выражений для строки идентификатора handshake требует «h-», за которым следуют от 8 до 32 строчных букв или цифр.
Type -> (строка)
Сокращенный синтаксис:
Id=string,Type=string
JSON синтаксис:
{
"Id": "string",
"Type": "ACCOUNT"|"ORGANIZATION"|"EMAIL"
}
--notes (строка)
--tags (список)
Список тегов, которые вы хотите прикрепить к учетной записи, когда она станет членом организации. Для каждого тега в списке необходимо указать ключ и значение тега. Вы можете установить значение в пустую строку, но не можете установить его в null . Дополнительную информацию о тегах см. в руководстве по организации «Тегирование ресурсов организаций».
Предупреждение
Любые теги в запросе проверяются на соответствие любым применимым правилам тегов при выполнении запроса. Запрос отклоняется, если теги в запросе не соответствуют требованиям политики в этот момент. Соответствие политике тегов * не * проверяется повторно при принятии приглашения и фактическом прикреплении тегов к учетной записи. Это означает, что если политика тегов изменится между приглашением и принятием, то теги могут потенциально быть несоответствующими.Примечание
Если любой из тегов недействителен или если вы превысили разрешенное количество тегов для учетной записи, весь запрос завершается неудачей, и приглашения не отправляются.(структура)
Пользовательский ключ-значение, связанный с ресурсом в вашей организации.
Вы можете прикрепить теги к любому из следующих ресурсов организации.
- Учетная запись Amazon Web Services
- Организационная единица (OU)
- Корень организации
- Политика
Key -> (строка)
Value -> (строка)
Сокращенный синтаксис:
Key=string,Value=string ...
JSON синтаксис:
[
{
"Key": "string",
"Value": "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
- таблица
- yaml
- yaml-потоковый
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование конкретного профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить вывод цвета.
- включено
- выключено
- автоматически
--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-в-base64-out
--no-cli-pager (булево)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматический запрос параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.
Если не указано иное, все примеры имеют правила цитирования, похожие на правила Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.
Для приглашения учетной записи в организацию
Следующий пример демонстрирует, как основная учетная запись, принадлежащая bill@example.com, приглашает учетную запись, принадлежащую juan@example.com, присоединиться к организации:
aws organizations invite-account-to-organization --target '{"Type": "EMAIL", "Id": "juan@example.com"}' --notes "This is a request for Juan's account to join Bill's organization."
Вывод включает структуру handshake, которая показывает, что отправляется приглашенной учетной записи:
{
"Handshake": {
"Action": "INVITE",
"Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
"ExpirationTimestamp": 1482952459.257,
"Id": "h-examplehandshakeid111",
"Parties": [
{
"Id": "o-exampleorgid",
"Type": "ORGANIZATION"
},
{
"Id": "juan@example.com",
"Type": "EMAIL"
}
],
"RequestedTimestamp": 1481656459.257,
"Resources": [
{
"Resources": [
{
"Type": "MASTER_EMAIL",
"Value": "bill@amazon.com"
},
{
"Type": "MASTER_NAME",
"Value": "Org Master Account"
},
{
"Type": "ORGANIZATION_FEATURE_SET",
"Value": "FULL"
}
],
"Type": "ORGANIZATION",
"Value": "o-exampleorgid"
},
{
"Type": "EMAIL",
"Value": "juan@example.com"
}
],
"State": "OPEN"
}
}
Вывод
Handshake -> (структура)
Структура, содержащая подробности о рукопожатии, созданном для поддержки этого запроса на приглашение.
Id -> (строка)
Уникальный идентификатор (ID) рукопожатия. Исходный аккаунт создает ID при инициировании рукопожатия.
Шаблон регулярных выражений для строки ID рукопожатия требует “h-” и от 8 до 32 строчных букв или цифр.
Arn -> (строка)
Amazon Resource Name (ARN) рукопожатия.
Дополнительную информацию об ARN в Organizations см. в Справочнике по авторизации сервисов Amazon Web Services, разделе ARN-форматы, поддерживаемые Organizations.
Parties -> (список)
Информация о двух учетных записях, участвующих в рукопожатии.
(структура)
Идентифицирует участника в рукопожатии.
Id -> (строка)
Уникальный идентификатор (ID) стороны.
Шаблон регулярных выражений для строки ID рукопожатия требует “h-” и от 8 до 32 строчных букв или цифр.
Type -> (строка)
State -> (строка)
Текущее состояние рукопожатия. Используйте состояние для отслеживания этапов рукопожатия от его создания до его принятия. Значения и их смысл:
- REQUESTED : Это рукопожатие было отправлено нескольким получателям (применимо только к некоторым типам рукопожатий), и не все получатели еще ответили. Запрос остается в этом состоянии, пока все получатели не ответят.
- OPEN : Это рукопожатие было отправлено нескольким получателям (применимо только к некоторым типам политик) и все получатели ответили, что позволяет инициатору выполнить действие рукопожатия.
- CANCELED : Рукопожатие больше не активное, поскольку оно было отменено исходной учетной записью.
- ACCEPTED : Рукопожатие завершено, так как оно было принято получателем.
- DECLINED : Рукопожатие больше не активное, поскольку оно было отклонено получателем.
- EXPIRED : Рукопожатие больше не активное, поскольку инициатор не получил ответа от получателя до времени истечения срока действия (15 дней).
RequestedTimestamp -> (отметка времени)
ExpirationTimestamp -> (отметка времени)
Action -> (строка)
Тип рукопожатия, указывающий какое действие происходит при принятии рукопожатия получателем. Поддерживаются следующие типы рукопожатий:
- INVITE : Этот тип рукопожатия представляет собой запрос на присоединение к организации. Он всегда отправляется из учетной записи управления только учетным записям, которые не являются членами.
- ENABLE_ALL_FEATURES : Этот тип рукопожатия представляет собой запрос на включение всех функций в организации. Он всегда отправляется из учетной записи управления только приглашенным учетным записям-членам. Учетные записи, созданные с помощью учетной записи управления организацией, не получают это, поскольку они были созданы учетной записью управления организацией, и одобрение считается подразумеваемым.
-
APPROVE_ALL_FEATURES : Этот тип рукопожатия отправляется службой Organizations, когда все учетные записи-члены одобрили
ENABLE_ALL_FEATURESприглашение. Он отправляется только в учетную запись управления и сигнализирует мастеру, что он может завершить процесс включения всех функций.
Resources -> (список)
Дополнительная информация, необходимая для обработки рукопожатия.
(структура)
Содержит дополнительные данные, необходимые для обработки рукопожатия.
Value -> (строка)
Type -> (строка)
Тип передаваемой информации, определяющий, как другая сторона должна интерпретировать значение:
-
ACCOUNT- Указывает номер ID учетной записи Amazon Web Services. -
ORGANIZATION- Указывает номер ID организации. -
EMAIL- Указывает адрес электронной почты, связанный с учетной записью, которая получает рукопожатие. -
OWNER_EMAIL- Указывает адрес электронной почты, связанный с учетной записью управления. Включено в качестве информации об организации. -
OWNER_NAME- Указывает имя, связанное с учетной записью управления. Включено в качестве информации об организации. -
NOTES- Дополнительный текст, предоставленный инициатором рукопожатия, предназначенный для прочтения получателем.
Resources -> (список)
При необходимости содержит дополнительный массив объектов HandshakeResource.
(структура)
Содержит дополнительные данные, необходимые для обработки рукопожатия.
Value -> (строка)
Type -> (строка)
Тип передаваемой информации, определяющий, как другая сторона должна интерпретировать значение:
-
ACCOUNT- Указывает номер ID учетной записи Amazon Web Services. -
ORGANIZATION- Указывает номер ID организации. -
EMAIL- Указывает адрес электронной почты, связанный с учетной записью, которая получает рукопожатие. -
OWNER_EMAIL- Указывает адрес электронной почты, связанный с учетной записью управления. Включено в качестве информации об организации. -
OWNER_NAME- Указывает имя, связанное с учетной записью управления. Включено в качестве информации об организации. -
NOTES- Дополнительный текст, предоставленный инициатором рукопожатия, предназначенный для прочтения получателем.
© Copyright 2025, Amazon Web Services. Created using Sphinx.