Spec-Zone.ru › AWS CLI v2

[ aws . detective ]

get-members

Описание

Возвращает сведения о членстве для указанных учетных записей-членов для графика поведения.

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

Синтаксис

  get-members
--graph-arn <value>
--account-ids <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]

Параметры

--graph-arn (строка)

ARN графика поведения, для которого необходимо запросить сведения о членстве.

--account-ids (список)

Список идентификаторов учетных записей Amazon Web Services для учетных записей-членов, для которых требуется вернуть сведения о членстве. Одновременно можно запросить сведения для до 50 учетных записей-членов.

Нельзя использовать GetMembers для получения информации об учетных записях-членах, удаленных из графика поведения.

(строка)

Синтаксис:

"string" "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
  • 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 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.

Для получения информации об отобранных учетных записях-членах графика поведения

Следующий пример get-members извлекает информацию о двух учетных записях-членах в графике поведения arn:aws:detective:us-east-1:111122223333:graph:123412341234. Для двух учетных записей запрос предоставляет идентификаторы AWS учетных записей.

aws detective get-members \
    --account-ids 444455556666 123456789012 \
    --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234

Вывод:

{
    "MemberDetails": [
    {
        "AccountId": "444455556666",
        "AdministratorId": "111122223333",
        "EmailAddress": "mmajor@example.com",
        "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
        "InvitedTime": 1579826107000,
        "MasterId": "111122223333",
        "Status": "INVITED",
        "UpdatedTime": 1579826107000
    }
    {
        "AccountId": "123456789012",
        "AdministratorId": "111122223333",
        "EmailAddress": "jstiles@example.com",
        "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234",
        "InvitedTime": 1579826107000,
        "MasterId": "111122223333",
        "Status": "INVITED",
        "UpdatedTime": 1579826107000
    }
],
    "UnprocessedAccounts": [ ]
}

Для получения дополнительной информации, см. `Просмотр списка учетных записей в графике поведения<https://docs.aws.amazon.com/detective/latest/adminguide/graph-admin-view-accounts.html>`__ в руководстве по администрированию Amazon Detective.

Вывод

MemberDetails -> (список)

Подробные сведения о учётной записи участника, возвращаемые детективом в ответ на запрос.

(структура)

Подробности о учётной записи участника в графе поведения.

AccountId -> (строка)

Идентификатор учётной записи Amazon Web Services для учётной записи участника.

EmailAddress -> (строка)

Адрес электронной почты корневого пользователя учётной записи Amazon Web Services для учётной записи участника.

GraphArn -> (строка)

ARN графы поведения.

MasterId -> (строка)

Идентификатор учётной записи Amazon Web Services учётной записи администратора для графы поведения.

AdministratorId -> (строка)

Идентификатор учётной записи Amazon Web Services учётной записи администратора для графы поведения.

Status -> (строка)

Текущий статус членства учётной записи участника. Статус может иметь одно из следующих значений:

  • INVITED - Только для приглашённых учётных записей. Указывает, что участнику было отправлено приглашение, но он ещё не ответил.
  • VERIFICATION_IN_PROGRESS - Только для приглашённых учётных записей, указывает, что Детектив проверяет, соответствуют ли идентификатор учётной записи и адрес электронной почты, указанные для учётной записи участника. Если соответствуют, то Детектив отправляет приглашение. Если адрес электронной почты и идентификатор учётной записи не соответствуют, то участник не может быть добавлен в графу поведения. Для учётных записей организации в организационной графе поведения указывает, что Детектив проверяет, принадлежит ли учётная запись организации.
  • VERIFICATION_FAILED - Только для приглашённых учётных записей. Указывает, что учётная запись и адрес электронной почты, указанные для учётной записи участника, не совпадают, и Детектив не отправлял приглашение в учётную запись.
  • ENABLED - Указывает, что учётная запись участника в настоящее время предоставляет данные в графу поведения. Для приглашённых учётных записей учётная запись участника приняла приглашение. Для учётных записей организации в организационной графе поведения учётная запись администратора Детектива включила учётную запись организации как учётную запись участника.
  • ACCEPTED_BUT_DISABLED - Учётная запись приняла приглашение или была включена учётной записью администратора Детектива, но ей запрещено предоставлять данные в графу поведения. DisabledReason указывает причину, по которой учётная запись участника не включена.

Учётные записи, которые отклонили приглашение или были удалены из графы поведения, не включаются. В организационной графе поведения учётные записи организаций, которые учётная запись администратора Детектива не включила, не включаются.

DisabledReason -> (строка)

Для учётных записей участников со статусом ACCEPTED_BUT_DISABLED указывается причина, по которой учётная запись участника не включена.

Причина может иметь одно из следующих значений:

  • VOLUME_TOO_HIGH - Указывает, что добавление учётной записи участника приведет к слишком большому объёму данных для графы поведения.
  • VOLUME_UNKNOWN - Указывает, что Детектив не может проверить объём данных для учётной записи участника. Это обычно происходит потому, что учётная запись участника не подключена к Amazon GuardDuty.

InvitedTime -> (отметка времени)

Для приглашённых учётных записей дата и время, когда Детектив отправил приглашение в учётную запись. Значение представляет собой строку в формате ISO8601. Например, 2021-08-18T16:35:56.284Z.

UpdatedTime -> (отметка времени)

Дата и время последнего обновления учётной записи участника. Значение представляет собой строку в формате ISO8601. Например, 2021-08-18T16:35:56.284Z.

VolumeUsageInBytes -> (целое)

Объём данных в байтах в день для учётной записи участника.

VolumeUsageUpdatedTime -> (отметка времени)

Дата и время последнего обновления объёма данных учётной записи участника. Значение представляет собой строку в формате ISO8601. Например, 2021-08-18T16:35:56.284Z.

PercentOfGraphUtilization -> (вещественное число)

Объём данных учётной записи участника в процентах от максимального разрешённого объёма данных. 0 соответствует 0 процентам, а 100 - 100 процентам.

Обратите внимание, что это не процент от объёма данных графы поведения.

Например, объём данных для графы поведения составляет 80 ГБ в день. Максимальный объём данных составляет 160 ГБ в день. Если объём данных для учётной записи участника составляет 40 ГБ в день, то PercentOfGraphUtilization составляет 25. Это соответствует 25% от максимального разрешённого объёма данных.

PercentOfGraphUtilizationUpdatedTime -> (отметка времени)

Дата и время последнего обновления процента использования графы. Значение представляет собой строку в формате ISO8601. Например, 2021-08-18T16:35:56.284Z.

InvitationType -> (строка)

Тип членства в графе поведения.

Для учётной записи организации в организационной графе поведения тип равен ORGANIZATION.

Для учётной записи, приглашённой в графу поведения, тип равен INVITATION.

VolumeUsageByDatasourcePackage -> (массив)

Подробности о объёме использования каждого пакета источников данных в графе поведения.

ключ -> (строка)

значение -> (структура)

Информация об использовании пакета источников данных в графе поведения.

VolumeUsageInBytes -> (целое)

Общий объём данных в байтах в день, полученный для данного пакета источников данных.

VolumeUsageUpdateTime -> (отметка времени)

Дата и время последнего обновления объёма данных учётной записи участника. Значение представляет собой строку в формате ISO8601. Например, 2021-08-18T16:35:56.284Z.

DatasourcePackageIngestStates -> (массив)

Состояние пакета источников данных для графы поведения.

ключ -> (строка)

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

UnprocessedAccounts -> (список)

Запрошенные учётные записи участников, для которых Детектив не смог вернуть подробные сведения о участниках.

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

(структура)

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

AccountId -> (строка)

Идентификатор учётной записи Amazon Web Services учётной записи участника, которая не была обработана.

Reason -> (строка)

Причина, по которой запрос для учётной записи участника не был обработан.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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