create-members
Описание
CreateMembers используется для отправки приглашений на счета. Для графика поведения организации учетная запись администратора Detective использует CreateMembers для включения счетов организации в качестве счетов-членов.Для приглашенных счетов CreateMembers отправляет запрос на приглашение указанных счетов Amazon Web Services в качестве счетов-членов в графике поведения. Данную операцию может выполнить только учетная запись администратора для графика поведения.
CreateMembers проверяет счета и затем приглашает проверенные счета. Администратор может по желанию указать, чтобы приглашения по электронной почте не отправлялись счетам-членам. Это используется, когда администратор управляет своими счетами-членами централизованно.Для счетов организации в графике поведения организации CreateMembers пытается включить счета. Счета организации не получают приглашений.
Запрос содержит ARN графика поведения и список счетов для приглашения или включения.
Ответ разделяет запрошенные счета на два списка:
- Счета, которые
CreateMembersудалось обработать. Для приглашенных счетов это включает счета-члены, которые проверяются, прошли проверку и будут приглашены, а также не прошли проверку. Для счетов организации в графике поведения организации это включает счета, которые могут быть включены, и которые не могут быть включены. - Счета, которые
CreateMembersне удалось обработать. Этот список включает счета, которые уже были приглашены в качестве счетов-членов в графике поведения.
См. также: Документация API AWS
Синтаксис
create-members
--graph-arn <value>
[--message <value>]
[--disable-email-notification | --no-disable-email-notification]
--accounts <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 (строка)
--message (строка)
--disable-email-notification | --no-disable-email-notification (логическое значение)
Если установлено значение true , приглашенные счета не получат уведомлений по электронной почте. По умолчанию это значение установлено как false , и приглашенные счета получают уведомления по электронной почте.
Счета организации в графике поведения организации не получают уведомлений по электронной почте.
--accounts (список)
Список счетов Amazon Web Services, которые нужно пригласить или включить. Одновременно можно пригласить или включить до 50 счетов. Для каждого приглашенного счета список счетов содержит идентификатор счета и адрес электронной почты корневого пользователя счета Amazon Web Services. Для счетов организации в графике поведения организации адрес электронной почты не требуется.
(структура)
Счет Amazon Web Services, который является учетной записью администратора или членом графика поведения.
AccountId -> (строка)
EmailAddress -> (строка)
Сокращенный синтаксис:
AccountId=string,EmailAddress=string ...
Синтаксис JSON:
[
{
"AccountId": "string",
"EmailAddress": "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.
Для приглашения счетов-членов в график поведения
В следующем create-members примере приглашаются два счета AWS для получения статуса счетов-членов в графике поведения arn:aws:detective:us-east-1:111122223333:graph:123412341234. Для каждого счета запрос содержит идентификатор счета AWS и адрес электронной почты корневого пользователя счета. Запрос содержит настраиваемое сообщение для вставки в электронное приглашение.
aws detective create-members \
--accounts AccountId=444455556666,EmailAddress=mmajor@example.com AccountId=123456789012,EmailAddress=jstiles@example.com \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \
--message "This is Paul Santos. I need to add your account to the data we use for security investigation in Amazon Detective. If you have any questions, contact me at psantos@example.com."
Вывод:
{
"Members": [
{
"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": "VERIFICATION_IN_PROGRESS",
"UpdatedTime": 1579826107000
}
],
"UnprocessedAccounts": [ ]
}
Дополнительную информацию см. в разделе `Приглашение счетов-членов в график поведения<https://docs.aws.amazon.com/detective/latest/adminguide/graph-admin-add-member-accounts.html>`__ в Руководстве администратора Amazon Detective.
Для приглашения счетов-членов без отправки приглашений по электронной почте
В следующем create-members примере приглашаются два счета AWS для получения статуса счетов-членов в графике поведения arn:aws:detective:us-east-1:111122223333:graph:123412341234. Для каждого счета запрос содержит идентификатор счета AWS и адрес электронной почты корневого пользователя счета. Счета-члены не получат приглашений по электронной почте.
aws detective create-members \
--accounts AccountId=444455556666,EmailAddress=mmajor@example.com AccountId=123456789012,EmailAddress=jstiles@example.com \
--graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \
--disable-email-notification
Вывод:
{
"Members": [
{
"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": "VERIFICATION_IN_PROGRESS",
"UpdatedTime": 1579826107000
}
],
"UnprocessedAccounts": [ ]
}
Дополнительную информацию см. в разделе `Приглашение счетов-членов в график поведения<https://docs.aws.amazon.com/detective/latest/adminguide/graph-admin-add-member-accounts.html>`__ в Руководстве администратора Amazon Detective.
Вывод
Участники -> (список)
Набор запросов на приглашение или включение учетных записей участников, которые служба Detective смогла обработать. Это включает учетные записи, которые проверяются, проверка которых не удалась, и проверка которых прошла успешно, и которые отправляют приглашение или включают.
(структура)
Подробные сведения об учетной записи участника в графе поведения.
AccountId -> (строка)
EmailAddress -> (строка)
GraphArn -> (строка)
MasterId -> (строка)
AdministratorId -> (строка)
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 -> (метка времени)
2021-08-18T16:35:56.284Z .UpdatedTime -> (метка времени)
2021-08-18T16:35:56.284Z .VolumeUsageInBytes -> (целое)
VolumeUsageUpdatedTime -> (метка времени)
2021-08-18T16:35:56.284Z .PercentOfGraphUtilization -> (двойное)
Объем данных учетной записи участника в процентах от максимально допустимого объема данных. 0 соответствует 0 процентам, а 100 — 100 процентам.
Обратите внимание, что это не процент от общего объема данных графы поведения.
Например, объем данных для графы поведения составляет 80 ГБ в день. Максимальный объем данных составляет 160 ГБ в день. Если объем данных для учетной записи участника составляет 40 ГБ в день, то PercentOfGraphUtilization составляет 25. Это 25% от максимально допустимого объема данных.
PercentOfGraphUtilizationUpdatedTime -> (метка времени)
2021-08-18T16:35:56.284Z .InvitationType -> (строка)
Тип членства в графе поведения.
Для учетной записи организации в организационной графе поведения тип — ORGANIZATION .
Для учетной записи, которая была приглашена в графу поведения, тип — INVITATION .
VolumeUsageByDatasourcePackage -> (карта)
Подробные сведения об объеме использования каждого пакета источников данных в графе поведения.
ключ -> (строка)
значение -> (структура)
Информация об использовании пакета источников данных в графе поведения.
VolumeUsageInBytes -> (целое)
VolumeUsageUpdateTime -> (метка времени)
2021-08-18T16:35:56.284Z .DatasourcePackageIngestStates -> (карта)
Состояние пакета источников данных для графы поведения.
ключ -> (строка)
значение -> (строка)
UnprocessedAccounts -> (список)
Список учетных записей, для которых служба Detective не смогла обработать запрос на приглашение или включение. Для каждой учетной записи список содержит причину, по которой запрос не удалось обработать. В список включены учетные записи, которые уже являются участниками в графе поведения.
(структура)
Учетная запись участника, которая была включена в запрос, но для которой запрос не удалось обработать.
AccountId -> (строка)
Reason -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.