Spec-Zone.ru › AWS CLI v2

[ aws . organizations ]

cancel-handshake

Описание

Отменяет рукопожатие. Отмена рукопожатия устанавливает состояние рукопожатия в CANCELED.

Этот операция может быть вызвана только из учетной записи, которая инициировала рукопожатие. Получатель рукопожатия не может его отменить, но может использовать DeclineHandshake вместо этого. После отмены рукопожатия получатель больше не может ответить на это рукопожатие.

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

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

Синтаксис

  cancel-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) рукопожатия, которое требуется отменить. Идентификатор можно получить из операции ListHandshakesForOrganization.

Шаблон регулярного выражения для строки 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
  • 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 версии 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.

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

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

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

aws organizations cancel-handshake --handshake-id h-examplehandshakeid111

Вывод включает объект рукопожатия, который показывает, что состояние теперь CANCELED:

{
        "Handshake": {
                "Id": "h-examplehandshakeid111",
                "State":"CANCELED",
                "Action": "INVITE",
                "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
                "Parties": [
                        {
                                "Id": "o-exampleorgid",
                                "Type": "ORGANIZATION"
                        },
                        {
                                "Id": "susan@example.com",
                                "Type": "EMAIL"
                        }
                ],
                "Resources": [
                        {
                                "Type": "ORGANIZATION",
                                "Value": "o-exampleorgid",
                                "Resources": [
                                        {
                                                "Type": "MASTER_EMAIL",
                                                "Value": "bill@example.com"
                                        },
                                        {
                                                "Type": "MASTER_NAME",
                                                "Value": "Master Account"
                                        },
                                        {
                                                "Type": "ORGANIZATION_FEATURE_SET",
                                                "Value": "CONSOLIDATED_BILLING"
                                        }
                                ]
                        },
                        {
                                "Type": "EMAIL",
                                "Value": "anika@example.com"
                        },
                        {
                                "Type": "NOTES",
                                "Value": "This is a request for Susan's account to join Bob's organization."
                        }
                ],
                "RequestedTimestamp": 1.47008383521E9,
                "ExpirationTimestamp": 1.47137983521E9
        }
}

Вывод

Рукопожатие -> (структура)

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

Id -> (строка)

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

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

Arn -> (строка)

Amazon Resource Name (ARN) рукопожатия.

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

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 : Этот тип рукопожатия отправляется службой Организации, когда все учётные записи-члены одобрили 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.

Spec-Zone.ru

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