list-handshakes-for-organization

Описание

Перечисляет соглашения о передаче прав, которые связаны с организацией, частью которой является запрашивающий пользователь. Операция ListHandshakesForOrganization возвращает список структур соглашений о передаче прав. Каждая структура содержит детали и состояние соглашения о передаче прав.

Соглашения о передаче прав, которые находятся в состоянии ACCEPTED , DECLINED , CANCELED или EXPIRED, отображаются в результатах этого API в течение 30 дней после изменения состояния. После этого они удаляются и больше недоступны.

Примечание

Всегда проверяйте параметр ответа NextToken на наличие значения null при вызове операции List*. Эти операции иногда могут возвращать пустой набор результатов, даже когда есть больше доступных результатов. Значение параметра ответа NextToken равно null только тогда, когда больше нет результатов для отображения.

Данная операция может быть вызвана только из учетной записи управления организацией или учетной записью-членом, которая является делегированным администратором службы Amazon Web Services.

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

list-handshakes-for-organization является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную загрузку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Handshakes

Синтаксис

  list-handshakes-for-organization
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--filter (структура)

Фильтр соглашений о передаче прав, которые должны быть включены в ответ. По умолчанию все типы. Используйте элемент ActionType, чтобы ограничить вывод только указанным типом, например, INVITE , ENABLE-ALL-FEATURES или APPROVE-ALL-FEATURES. В качестве альтернативы, для соглашения о передаче прав ENABLE-ALL-FEATURES, которое генерирует отдельное дочернее соглашение о передаче прав для каждой учетной записи-члена, вы можете указать ParentHandshakeId, чтобы видеть только соглашения о передаче прав, сгенерированные этим родительским запросом.

ActionType -> (строка)

Указывает тип действия соглашения о передаче прав.

Если вы укажете ActionType, вы также не можете указать ParentHandshakeId.

ParentHandshakeId -> (строка)

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

Если вы укажете ParentHandshakeId, вы также не можете указать ActionType.

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

Сокращенный синтаксис:

ActionType=string,ParentHandshakeId=string

Синтаксис JSON:

{
  "ActionType": "INVITE"|"ENABLE_ALL_FEATURES"|"APPROVE_ALL_FEATURES"|"ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE",
  "ParentHandshakeId": "string"
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Передавать произвольные двоичные значения с помощью предоставленного значения JSON невозможно, так как строка будет принята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания точки начала постраничной загрузки. Это NextToken из ранее укороченного ответа.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной загрузки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя AWS Command Line Interface.

--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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Примеры

Примечание

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

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

Для получения списка соглашений о передаче прав, связанных с организацией

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

aws organizations list-handshakes-for-organization

Вывод показывает два соглашения о передаче прав. Первое — приглашение в учетную запись Хуана и показывает состояние OPEN. Второе — приглашение в учетную запись Аники и показывает состояние ACCEPTED:

{
        "Handshakes": [
                {
                        "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"
                                },
                                {
                                        "Type":"NOTES",
                                        "Value":"This is an invitation to Juan's account to join Bill's organization."
                                }
                        ],
                        "State": "OPEN"
                },
                {
                        "Action": "INVITE",
                        "State":"ACCEPTED",
                        "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111",
                        "ExpirationTimestamp": 1.471797437427E9,
                        "Id": "h-examplehandshakeid222",
                        "Parties": [
                                {
                                        "Id": "o-exampleorgid",
                                        "Type": "ORGANIZATION"
                                },
                                {
                                        "Id": "anika@example.com",
                                        "Type": "EMAIL"
                                }
                        ],
                        "RequestedTimestamp": 1.469205437427E9,
                        "Resources": [
                                {
                                        "Resources": [
                                                {
                                                        "Type":"MASTER_EMAIL",
                                                        "Value":"bill@example.com"
                                                },
                                                {
                                                        "Type":"MASTER_NAME",
                                                        "Value":"Master Account"
                                                }
                                        ],
                                        "Type":"ORGANIZATION",
                                        "Value":"o-exampleorgid"
                                },
                                {
                                        "Type":"EMAIL",
                                        "Value":"anika@example.com"
                                },
                                {
                                        "Type":"NOTES",
                                        "Value":"This is an invitation to Anika's account to join Bill's organization."
                                }
                        ]
                }
        ]
}

Вывод

Рукостижания -> (список)

Список объектов Рукостижания с деталями о каждом из рукостижаний, связанных с организацией.

(структура)

Содержит информацию, которая должна быть обменена для безопасного установления связи между двумя учетными записями (инициатором и получателем). Например, когда учетная запись управления (инициатор) приглашает другую учетную запись (получателя) присоединиться к своей организации, две учетные записи обмениваются информацией в виде серии запросов и ответов рукостижания.

Примечание: Рукостижания, которые являются CANCELED , ACCEPTED , DECLINED или EXPIRED, отображаются в списках только 30 дней после перехода в это состояние. По истечении этого срока они удаляются.

Id -> (строка)

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

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

Arn -> (строка)

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

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

Участники -> (список)

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

(структура)

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

Id -> (строка)

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

Тип -> (строка)

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

Состояние -> (строка)

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

ЗАПРОШЕНО : Это рукостижание было отправлено нескольким получателям (применимо только к некоторым типам рукостижаний), и еще не все получатели ответили. Запрос остается в этом состоянии, пока все получатели не ответят.
ОТКРЫТО : Это рукостижание было отправлено нескольким получателям (применимо только к некоторым типам политик) и все получатели ответили, что позволяет инициатору выполнить действие рукостижания.
ОТМЕНЕНО : Это рукостижание больше не активно, так как оно было отменено инициатором учетной записи.
ПРИНЯТО : Это рукостижание завершено, так как оно было принято получателем.
ОТКЛОНЕНО : Это рукостижание больше не активно, так как оно было отклонено получателем.
ИСТЕКЛО : Это рукостижание больше не активно, так как инициатор не получил ответа от получателя до истечения срока действия (15 дней).

Timestamp запроса -> (временная метка)

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

Timestamp истечения срока действия -> (временная метка)

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

Действие -> (строка)

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

ПРИГЛАШЕНИЕ : Этот тип рукостижания представляет запрос на присоединение к организации. Он всегда отправляется от учетной записи управления только нечленам.
ВКЛЮЧИТЬ_ВСЕ_ФУНКЦИИ : Этот тип рукостижания представляет собой запрос на включение всех функций в организации. Он всегда отправляется от учетной записи управления только приглашенным членам. Созданные учетные записи не получают этого, потому что эти учетные записи были созданы учетной записью управления организации, и утверждение подразумевается.
УТВЕРДИТЬ_ВСЕ_ФУНКЦИИ : Этот тип рукостижания отправляется службой Организации, когда все учетные записи-члены одобрили ENABLE_ALL_FEATURES приглашение. Он отправляется только учетной записи управления и сигнализирует мастеру, что он может завершить процесс включения всех функций.

Ресурсы -> (список)

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

(структура)

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

Значение -> (строка)

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

Тип -> (строка)

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

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

Ресурсы -> (список)

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

(структура)

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

Значение -> (строка)

Тип -> (строка)

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

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

NextToken -> (строка)

Если присутствует, указывает, что доступно больше вывода, чем включено в текущий ответ. Используйте это значение в параметре запроса NextToken в последующем вызове операции для получения следующей части вывода. Вам следует повторять это до тех пор, пока элемент ответа NextToken не вернет null.

END_OF_DOCUMENT_MARKER