Spec-Zone.ru › AWS CLI v2

[ aws . detective ]

list-invitations

Описание

Получает список открытых и принятых приглашений на графики поведения для учетной записи-члена. Данная операция может быть вызвана только приглашенной учетной записью-членом.

Открытые приглашения — это приглашения, на которые учетная запись-член еще не ответила.

Результаты не включают графики поведения, для которых учетная запись-член отклонила приглашение. Результаты также не включают графики поведения, из которых учетная запись-член вышла или из которых ее исключили.

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

Синтаксис

  list-invitations
[--next-token <value>]
[--max-results <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]

Параметры

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

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

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

Максимальное количество приглашений на графики поведения, которые должны быть возвращены в ответе. Общее количество должно быть меньше общего лимита на количество возвращаемых результатов, который в настоящее время составляет 200.

--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 (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки config/env.

--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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

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

Следующий list-invitations пример получает графики поведения, для которых учетная запись вызова получила приглашение. Результаты включают только открытые и принятые приглашения. Они не включают отклоненные приглашения или удаленные членства.

aws detective list-invitations

Вывод:

{
    "Invitations": [
    {
        "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
    }
]
}

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

Вывод

Приглашения -> (список)

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

(структура)

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

AccountId -> (строка)

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

EmailAddress -> (строка)

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

GraphArn -> (строка)

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

MasterId -> (строка)

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

AdministratorId -> (строка)

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

Status -> (строка)

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

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

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

DisabledReason -> (строка)

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

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

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

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

Для приглашенных учетных записей дата и время, когда Detective отправил приглашение учетной записи. Значение представляет собой строку в формате 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 -> (массив)

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

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

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

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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