Spec-Zone.ru › AWS CLI v2

[ aws . organizations ]

accept-handshake

Описание

Отправляет ответ инициатору рукопожатия, соглашаясь с действием, предложенным запросом на рукопожатие.

Вы можете вызвать эту операцию только с помощью следующих принципалов, когда у них также есть соответствующие разрешения IAM:

  • Приглашение к присоединению или Запрос на одобрение всех функций рукопожатия: только принципал из учетной записи-члена. Пользователь, вызывающий API для приглашения к присоединению, должен иметь разрешение organizations:AcceptHandshake. Если вы включили все функции в организации, пользователю также необходимо разрешение iam:CreateServiceLinkedRole, чтобы Organizations могли создать необходимую роль для связи с сервисами под названием AWSServiceRoleForOrganizations. Дополнительную информацию см. в разделе «Organizations и роли связи с сервисами» в руководстве пользователя Organizations.
  • Окончательное подтверждение включения всех функций рукопожатия: только принципал из учетной записи управления. Дополнительную информацию о приглашениях см. в разделе «Приглашение учетной записи Amazon Web Services к присоединению к вашей организации» в руководстве пользователя Organizations. Дополнительную информацию о запросах на включение всех функций в организации см. в разделе «Включение всех функций в вашей организации» в руководстве пользователя Organizations.

После принятия рукопожатия оно продолжает отображаться в результатах соответствующих API в течение 30 дней. После этого оно удаляется.

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

Синопсис

  accept-handshake
--handshake-id <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]

Параметры

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

Уникальный идентификатор (ID) рукопожатия, которое вы хотите принять.

Шаблон регулярного выражения для строки ID рукопожатия требует «h-», за которым следуют от 8 до 32 строчных букв или цифр.

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое)

Отключить перелистывание cli для вывода.

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

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

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

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, подобные Unix. Эти примеры потребуют адаптации к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

Для принятия рукопожатия от другой учетной записи

Билл, владелец организации, ранее пригласил учетную запись Хуана присоединиться к своей организации. Следующий пример демонстрирует, как учетная запись Хуана принимает рукопожатие и, таким образом, соглашается с приглашением.

aws organizations accept-handshake --handshake-id h-examplehandshakeid111

Вывод показывает следующее:

{
        "Handshake": {
                "Action": "INVITE",
                "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
                "RequestedTimestamp": 1481656459.257,
                "ExpirationTimestamp": 1482952459.257,
                "Id": "h-examplehandshakeid111",
                "Parties": [
                        {
                                "Id": "o-exampleorgid",
                                "Type": "ORGANIZATION"
                        },
                        {
                                "Id": "juan@example.com",
                                "Type": "EMAIL"
                        }
                ],
                "Resources": [
                        {
                                "Resources": [
                                        {
                                                "Type": "MASTER_EMAIL",
                                                "Value": "bill@amazon.com"
                                        },
                                        {
                                                "Type": "MASTER_NAME",
                                                "Value": "Org Master Account"
                                        },
                                        {
                                                "Type": "ORGANIZATION_FEATURE_SET",
                                                "Value": "ALL"
                                        }
                                ],
                                "Type": "ORGANIZATION",
                                "Value": "o-exampleorgid"
                        },
                        {
                                "Type": "EMAIL",
                                "Value": "juan@example.com"
                        }
                ],
                "State": "ACCEPTED"
        }
}

Вывод

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

Структура, содержащая сведения о принятом рукопожатии.

Id -> (строка)

Уникальный идентификатор (ID) рукопожатия. Идентификатор создается исходной учетной записью при инициализации рукопожатия.

Шаблон регулярных выражений для строки идентификатора рукопожатия требует «h-», за которым следуют от 8 до 32 строчных букв или цифр.

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) рукопожатия.

Дополнительную информацию об ARN в Организациях см. в разделе Форматы ARN, поддерживаемые Организациями, в Справочнике по авторизации сервисов Amazon Web Services.

Parties -> (список)

Информация о двух учетных записях, участвующих в рукопожатии.

(структура)

Идентифицирует участника рукопожатия.

Id -> (строка)

Уникальный идентификатор (ID) участника.

Шаблон регулярных выражений для строки идентификатора рукопожатия требует «h-», за которым следуют от 8 до 32 строчных букв или цифр.

Type -> (строка)

Тип участника.

State -> (строка)

Текущее состояние рукопожатия. Используйте состояние для отслеживания процесса рукопожатия от его создания до его принятия. Значение каждого из допустимых значений следующее:

  • REQUESTED : Это рукопожатие было отправлено нескольким получателям (применимо только к некоторым типам рукопожатий), и пока не все получатели ответили. Запрос остается в этом состоянии до тех пор, пока все получатели не ответят.
  • OPEN : Это рукопожатие было отправлено нескольким получателям (применимо только к некоторым типам политики) и все получатели ответили, что позволяет инициатору завершить действие рукопожатия.
  • CANCELED : Это рукопожатие больше неактивно, так как было отменено исходной учетной записью.
  • ACCEPTED : Это рукопожатие завершено, поскольку оно было принято получателем.
  • DECLINED : Это рукопожатие больше неактивно, так как оно было отклонено получателем.
  • EXPIRED : Это рукопожатие больше неактивно, так как инициатор не получил никакого ответа от получателя до истечения срока действия (15 дней).

RequestedTimestamp -> (временная метка)

Дата и время запроса рукопожатия.

ExpirationTimestamp -> (временная метка)

Дата и время истечения срока действия рукопожатия. Если получатель запроса рукопожатия не ответит до указанной даты и времени, рукопожатие станет неактивным и более недействительным.

Action -> (строка)

Тип рукопожатия, указывающий действие, которое происходит при принятии рукопожатия получателем. Поддерживаются следующие типы рукопожатий:

  • INVITE : Этот тип рукопожатия представляет запрос на присоединение к организации. Он всегда отправляется учетной записью управления только учетным записям, не являющимся членами.
  • ENABLE_ALL_FEATURES : Этот тип рукопожатия представляет запрос на включение всех функций в организации. Он всегда отправляется учетной записью управления только приглашенным учетным записям-членам. Созданные учетные записи не получают это, потому что эти учетные записи были созданы учетной записью управления организацией, и одобрение подразумевается.
  • APPROVE_ALL_FEATURES : Этот тип рукопожатия отправляется службой Организации, когда все учетные записи-члены одобрили ENABLE_ALL_FEATURES приглашение. Он отправляется только учетной записи управления и сигнализирует мастеру, что он может завершить процесс включения всех функций.

Resources -> (список)

Дополнительная информация, необходимая для обработки рукопожатия.

(структура)

Содержит дополнительные данные, необходимые для обработки рукопожатия.

Value -> (строка)

Информация, передаваемая другой стороне в рукопожатии. Формат строки значения должен соответствовать требованиям указанного типа.

Type -> (строка)

Тип передаваемой информации, определяющий, как получатель интерпретирует значение:

  • ACCOUNT - Указывает номер идентификатора учетной записи Amazon Web Services.
  • ORGANIZATION - Указывает номер идентификатора организации.
  • EMAIL - Указывает адрес электронной почты, связанный с учетной записью, которая получает рукопожатие.
  • OWNER_EMAIL - Указывает адрес электронной почты, связанный с учетной записью управления. Включено как информация об организации.
  • OWNER_NAME - Указывает имя, связанное с учетной записью управления. Включено как информация об организации.
  • NOTES - Дополнительный текст, предоставленный инициатором рукопожатия и предназначенный для прочтения получателем.

Resources -> (список)

При необходимости содержит дополнительный массив объектов HandshakeResource.

(структура)

Содержит дополнительные данные, необходимые для обработки рукопожатия.

Value -> (строка)

Информация, передаваемая другой стороне в рукопожатии. Формат строки значения должен соответствовать требованиям указанного типа.

Type -> (строка)

Тип передаваемой информации, определяющий, как получатель интерпретирует значение:

  • ACCOUNT - Указывает номер идентификатора учетной записи Amazon Web Services.
  • ORGANIZATION - Указывает номер идентификатора организации.
  • EMAIL - Указывает адрес электронной почты, связанный с учетной записью, которая получает рукопожатие.
  • OWNER_EMAIL - Указывает адрес электронной почты, связанный с учетной записью управления. Включено как информация об организации.
  • OWNER_NAME - Указывает имя, связанное с учетной записью управления. Включено как информация об организации.
  • NOTES - Дополнительный текст, предоставленный инициатором рукопожатия и предназначенный для прочтения получателем.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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