Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

получение подробного состояния пакета соответствия организации

Описание

Возвращает подробное состояние каждого учетной записи участника в организации для данного пакета соответствия организации.

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

get-organization-conformance-pack-detailed-status это постраничный процесс. Для получения всего набора результатов могут быть вызваны несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: OrganizationConformancePackDetailedStatuses

Синтаксис

  get-organization-conformance-pack-detailed-status
--organization-conformance-pack-name <value>
[--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-conformance-pack-name (строка)

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

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

Объект OrganizationResourceDetailedStatusFilters.

AccountId -> (строка)

12-значный идентификатор учетной записи участника в организации.

Status -> (строка)

Указывает состояние развертывания пакета соответствия в учетной записи участника. Когда управляющая учетная запись впервые вызывает действие PutOrganizationConformancePack для пакета соответствия, состояние пакета создается в учетной записи участника. Когда управляющая учетная запись во второй раз вызывает действие PutOrganizationConformancePack, состояние пакета обновляется в учетной записи участника. Состояние пакета соответствия удаляется, когда управляющая учетная запись удаляет OrganizationConformancePack и отключает доступ к сервису для config-multiaccountsetup.amazonaws.com.

Config устанавливает состояние пакета соответствия в:

  • CREATE_SUCCESSFUL когда пакет соответствия был создан в учетной записи участника.
  • CREATE_IN_PROGRESS когда пакет соответствия создается в учетной записи участника.
  • CREATE_FAILED когда создание пакета соответствия завершилось ошибкой в учетной записи участника.
  • DELETE_FAILED когда удаление пакета соответствия завершилось ошибкой в учетной записи участника.
  • DELETE_IN_PROGRESS когда пакет соответствия удаляется в учетной записи участника.
  • DELETE_SUCCESSFUL когда пакет соответствия был удален в учетной записи участника.
  • UPDATE_SUCCESSFUL когда пакет соответствия был обновлен в учетной записи участника.
  • UPDATE_IN_PROGRESS когда пакет соответствия обновляется в учетной записи участника.
  • UPDATE_FAILED когда удаление пакета соответствия завершилось ошибкой в учетной записи участника.

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

AccountId=string,Status=string

Синтаксис JSON:

{
  "AccountId": "string",
  "Status": "CREATE_SUCCESSFUL"|"CREATE_IN_PROGRESS"|"CREATE_FAILED"|"DELETE_SUCCESSFUL"|"DELETE_FAILED"|"DELETE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"
}

--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.

Вывод

OrganizationConformancePackDetailedStatuses -> (список)

Список объектов OrganizationConformancePackDetailedStatus.

(структура)

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

AccountId -> (строка)

12-значный идентификатор учетной записи участника.

ConformancePackName -> (строка)

Имя пакета соответствия, развернутого в учетной записи участника.

Status -> (строка)

Указывает состояние развертывания пакета соответствия в учетной записи участника. Когда управляющая учетная запись впервые вызывает действие PutOrganizationConformancePack для пакета соответствия, состояние пакета создается в учетной записи участника. Когда управляющая учетная запись во второй раз вызывает действие PutOrganizationConformancePack, состояние пакета обновляется в учетной записи участника. Состояние пакета соответствия удаляется, когда управляющая учетная запись удаляет OrganizationConformancePack и отключает доступ к сервису для config-multiaccountsetup.amazonaws.com.

Config устанавливает состояние пакета соответствия в:

  • CREATE_SUCCESSFUL когда пакет соответствия был создан в учетной записи участника.
  • CREATE_IN_PROGRESS когда пакет соответствия создается в учетной записи участника.
  • CREATE_FAILED когда создание пакета соответствия завершилось ошибкой в учетной записи участника.
  • DELETE_FAILED когда удаление пакета соответствия завершилось ошибкой в учетной записи участника.
  • DELETE_IN_PROGRESS когда пакет соответствия удаляется в учетной записи участника.
  • DELETE_SUCCESSFUL когда пакет соответствия был удален в учетной записи участника.
  • UPDATE_SUCCESSFUL когда пакет соответствия был обновлен в учетной записи участника.
  • UPDATE_IN_PROGRESS когда пакет соответствия обновляется в учетной записи участника.
  • UPDATE_FAILED когда удаление пакета соответствия завершилось ошибкой в учетной записи участника.

ErrorCode -> (строка)

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

ErrorMessage -> (строка)

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

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

Метка времени последнего обновления состояния.

NextToken -> (строка)

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

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

Spec-Zone.ru

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