Spec-Zone.ru › AWS CLI v2

[ aws . health ]

describe-affected-entities-for-organization

Описание

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

Требуется как минимум один идентификатор события Amazon Resource Name (ARN) и идентификатор учетной записи.

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

Примечание

  • Эта операция API использует пагинацию. Укажите параметр nextToken в следующем запросе, чтобы получить больше результатов.
  • Эта операция не поддерживает разрешения на уровне ресурсов. Вы не можете использовать эту операцию для разрешения или запрета доступа к конкретным событиям Health. Для получения дополнительной информации см. Условия на основе ресурсов и действий в Руководстве пользователя Health.

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

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

Синтаксис

  describe-affected-entities-for-organization
[--organization-entity-filters <value>]
[--locale <value>]
[--organization-entity-account-filters <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]

Параметры

--organization-entity-filters (список)

JSON-набор элементов, включающий awsAccountId и eventArn.

(структура)

Значения, используемые для фильтрации результатов операций DescribeEventDetailsForOrganization и DescribeAffectedEntitiesForOrganization.

eventArn -> (строка)

Уникальный идентификатор события. ARN события имеет формат ``arn:aws:health:event-region ::event/SERVICE /EVENT_TYPE_CODE /EVENT_TYPE_PLUS_ID ``.

Например, ARN события может выглядеть следующим образом:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

awsAccountId -> (строка)

12-значные номера счетов Amazon Web Services, содержащие затронутые сущности.

Сокращенная запись:

eventArn=string,awsAccountId=string ...

JSON-синтаксис:

[
  {
    "eventArn": "string",
    "awsAccountId": "string"
  }
  ...
]

--locale (строка)

Язык (locale), в котором должна отображаться информация. По умолчанию используется английский (en), и на данный момент это единственный поддерживаемый язык.

--organization-entity-account-filters (список)

JSON-набор элементов, включающий awsAccountId, eventArn и набор statusCodes.

(структура)

JSON-набор элементов, включающий awsAccountId, eventArn и набор statusCodes.

eventArn -> (строка)

Уникальный идентификатор события. ARN события имеет формат ``arn:aws:health:event-region ::event/SERVICE /EVENT_TYPE_CODE /EVENT_TYPE_PLUS_ID ``.

Например, ARN события может выглядеть следующим образом:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

awsAccountId -> (строка)

12-значные номера счетов Amazon Web Services, содержащие затронутые сущности.

statusCodes -> (список)

Список кодов состояния сущности.

(строка)

Сокращенная запись:

eventArn=string,awsAccountId=string,statusCodes=string,string ...

JSON-синтаксис:

[
  {
    "eventArn": "string",
    "awsAccountId": "string",
    "statusCodes": ["IMPAIRED"|"UNIMPAIRED"|"UNKNOWN"|"PENDING"|"RESOLVED", ...]
  }
  ...
]

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Используемая область. Переопределяет настройки конфигурации/среды.

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • авто

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

entities -> (список)

Набор элементов JSON, включающий awsAccountId и его entityArn , entityValue и его entityArn , lastUpdatedTime и statusCode .

(структура)

Информация об элементе, затронутом событием Health.

entityArn -> (строка)

Уникальный идентификатор элемента. Формат: arn:aws:health:*entity-region* :*aws-account* :entity/*entity-id* `` . Example: ``arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K

eventArn -> (строка)

Уникальный идентификатор события. ARN события имеет формат ``arn:aws:health:event-region ::event/SERVICE /EVENT_TYPE_CODE /EVENT_TYPE_PLUS_ID ``.

Например, ARN события может выглядеть следующим образом:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

entityValue -> (строка)

Идентификатор затронутого элемента.

entityUrl -> (строка)

URL затронутого элемента.

awsAccountId -> (строка)

12-значный номер учетной записи Amazon Web Services, содержащий затронутый элемент.

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

Последнее время обновления элемента.

statusCode -> (строка)

Последний статус элемента, затронутого событием. Возможные значения: IMPAIRED , UNIMPAIRED и UNKNOWN .

tags -> (карта)

Карта тегов элемента, прикрепленных к затронутому элементу.

Примечание

В настоящее время свойство tags не поддерживается.

key -> (строка)

value -> (строка)

entityMetadata -> (карта)

Дополнительные метаданные о затронутом элементе.

key -> (строка)

value -> (строка)

failedSet -> (список)

Набор элементов JSON неудачного ответа, включающий awsAccountId , errorMessage , errorName и eventArn .

(структура)

Информация об ошибке, возвращаемая при невозможности найти или обработать определенный элемент операцией DescribeAffectedEntitiesForOrganization.

awsAccountId -> (строка)

12-значные номера учетных записей Amazon Web Services, содержащие затронутые элементы.

eventArn -> (строка)

Уникальный идентификатор события. ARN события имеет формат ``arn:aws:health:event-region ::event/SERVICE /EVENT_TYPE_CODE /EVENT_TYPE_PLUS_ID ``.

Например, ARN события может выглядеть следующим образом:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

errorName -> (строка)

Имя ошибки.

errorMessage -> (строка)

Сообщение, описывающее ошибку. Следуйте сообщению об ошибке и повторите запрос.

Например, сообщение об ошибке InvalidAccountInputError появляется, если вы вызываете операцию DescribeAffectedEntitiesForOrganization и указываете значение AccountSpecific для параметра EventScopeCode, но не указываете учетную запись Amazon Web Services.

nextToken -> (строка)

Если результаты поиска объемны, возвращается только часть результатов, и в ответе возвращается маркер пагинации nextToken. Чтобы получить следующую партию результатов, повторите запрос поиска и включите возвращенный маркер. Когда все результаты будут возвращены, в ответе маркер пагинации не содержится.

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

Spec-Zone.ru

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