Spec-Zone.ru › AWS CLI v2

[ aws . devops-guru ]

list-organization-insights

Описание

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

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

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

Синтаксис

  list-organization-insights
--status-filter <value>
[--account-ids <value>]
[--organizational-unit-ids <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]

Параметры

--status-filter (структура)

Фильтр, используемый ListInsights для указания, какие инсайты нужно вернуть.

Ongoing -> (структура)

Структура, которая определяет инсайты в процессе, которые являются либо REACTIVE, либо PROACTIVE.

Type -> (строка)

Используйте для фильтрации инсайтов типа REACTIVE или PROACTIVE.

Closed -> (структура)

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

Type -> (строка)

Используйте для фильтрации инсайтов типа REACTIVE или PROACTIVE.

EndTimeRange -> (структура)

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

FromTime -> (временная метка)

Самое раннее время окончания в диапазоне времени.

ToTime -> (временная метка)

Самое позднее время окончания в диапазоне времени.

Any -> (структура)

Структура, которая определяет инсайты любого статуса, которые являются либо REACTIVE, либо PROACTIVE.

Type -> (строка)

Используйте для фильтрации инсайтов типа REACTIVE или PROACTIVE.

StartTimeRange -> (структура)

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

FromTime -> (временная метка)

Время начала диапазона времени.

ToTime -> (временная метка)

Время окончания диапазона времени.

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

Ongoing={Type=string},Closed={Type=string,EndTimeRange={FromTime=timestamp,ToTime=timestamp}},Any={Type=string,StartTimeRange={FromTime=timestamp,ToTime=timestamp}}

Синтаксис JSON:

{
  "Ongoing": {
    "Type": "REACTIVE"|"PROACTIVE"
  },
  "Closed": {
    "Type": "REACTIVE"|"PROACTIVE",
    "EndTimeRange": {
      "FromTime": timestamp,
      "ToTime": timestamp
    }
  },
  "Any": {
    "Type": "REACTIVE"|"PROACTIVE",
    "StartTimeRange": {
      "FromTime": timestamp,
      "ToTime": timestamp
    }
  }
}

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

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

(строка)

Синтаксис:

"string" "string" ...

--organizational-unit-ids (список)

Идентификатор организационной единицы.

(строка)

Синтаксис:

"string" "string" ...

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

Output

ProactiveInsights -> (list)

Целое число, которое указывает количество открытых упреждающих аналитических данных в вашей учетной записи Amazon Web Services.

(structure)

Сведения об упреждающей аналитике. Этот объект возвращается DescribeInsight.

Id -> (string)

Идентификатор сводки аналитики.

AccountId -> (string)

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

OrganizationalUnitId -> (string)

Идентификатор организационного подразделения.

Name -> (string)

Имя сводки аналитики.

Severity -> (string)

Массив значений серьезности, используемых для поиска аналитических данных. Для получения дополнительной информации см. раздел Understanding insight severities в Руководстве пользователя Amazon DevOps Guru .

Status -> (string)

Массив значений статуса, используемых для поиска аналитических данных.

InsightTimeRange -> (structure)

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

StartTime -> (timestamp)

Время начала поведения, описанного в аналитике.

EndTime -> (timestamp)

Время окончания поведения, описанного в аналитике.

PredictionTimeRange -> (structure)

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

StartTime -> (timestamp)

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

EndTime -> (timestamp)

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

ResourceCollection -> (structure)

Коллекция ресурсов Amazon Web Services, поддерживаемых DevOps Guru. Поддерживаются два типа коллекций ресурсов Amazon Web Services: стеки Amazon Web Services CloudFormation и ресурсы Amazon Web Services, содержащие один и тот же тег Amazon Web Services. DevOps Guru можно настроить для анализа ресурсов Amazon Web Services, которые определены в стеках или помечены с использованием одного и того же ключа тега. Можно указать до 500 стеков Amazon Web Services CloudFormation.

CloudFormation -> (structure)

Массив имен стеков Amazon Web Services CloudFormation. Стеки определяют ресурсы Amazon Web Services, которые анализирует DevOps Guru. Можно указать до 500 стеков Amazon Web Services CloudFormation.

StackNames -> (list)

Массив имен стеков CloudFormation.

(string)

Tags -> (list)

Теги Amazon Web Services, используемые ресурсами в коллекции ресурсов.

Теги помогают идентифицировать и упорядочивать ваши ресурсы Amazon Web Services. Многие сервисы Amazon Web Services поддерживают тегирование, поэтому вы можете назначить один и тот же тег ресурсам из разных сервисов, чтобы указать, что эти ресурсы связаны. Например, можно назначить один и тот же тег ресурсу таблицы Amazon DynamoDB, который вы назначаете функции Lambda. Для получения дополнительной информации об использовании тегов см. whitepaper Tagging best practices.

Каждый тег Amazon Web Services состоит из двух частей.

  • Ключ тега (например, CostCenter, Environment, Project или Secret). Ключи тегов чувствительны к регистру.
  • Необязательное поле, известное как значение тега (например, 111122223333, Production или имя команды). Опущение значения тега эквивалентно использованию пустой строки. Как и ключи тегов, значения тегов чувствительны к регистру.

Вместе они известны как пары ключ -значение.

Предупреждение

Строка, используемая для ключа в теге, который вы используете для определения охвата ресурса, должна начинаться с префикса Devops-guru-. Ключ тега может быть DevOps-Guru-deployment-application или devops-guru-rds-application. При создании ключа регистр символов в ключе может быть любым. После создания ключа он чувствителен к регистру. Например, DevOps Guru работает с ключом с именем devops-guru-rds и ключом с именем DevOps-Guru-RDS, и они действуют как два разных ключа. Возможные пары ключ/значение в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers.

(structure)

Коллекция тегов Amazon Web Services.

Теги помогают идентифицировать и упорядочивать ваши ресурсы Amazon Web Services. Многие сервисы Amazon Web Services поддерживают тегирование, поэтому вы можете назначить один и тот же тег ресурсам из разных сервисов, чтобы указать, что эти ресурсы связаны. Например, можно назначить один и тот же тег ресурсу таблицы Amazon DynamoDB, который вы назначаете функции Lambda. Для получения дополнительной информации об использовании тегов см. whitepaper Tagging best practices.

Каждый тег Amazon Web Services состоит из двух частей.

  • Ключ тега (например, CostCenter, Environment, Project или Secret). Ключи тегов чувствительны к регистру.
  • Необязательное поле, известное как значение тега (например, 111122223333, Production или имя команды). Опущение значения тега эквивалентно использованию пустой строки. Как и ключи тегов, значения тегов чувствительны к регистру.

Вместе они известны как пары ключ -значение.

Предупреждение

Строка, используемая для ключа в теге, который вы используете для определения охвата ресурса, должна начинаться с префикса Devops-guru-. Ключ тега может быть DevOps-Guru-deployment-application или devops-guru-rds-application. При создании ключа регистр символов в ключе может быть любым. После создания ключа он чувствителен к регистру. Например, DevOps Guru работает с ключом с именем devops-guru-rds и ключом с именем DevOps-Guru-RDS, и они действуют как два разных ключа. Возможные пары ключ/значение в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers.

AppBoundaryKey -> (string)

Ключ тега Amazon Web Services, который используется для идентификации ресурсов Amazon Web Services, которые анализирует DevOps Guru. Все ресурсы Amazon Web Services в вашей учетной записи и регионе, помеченные этим ключом, составляют ваше приложение DevOps Guru и границу анализа.

Предупреждение

Строка, используемая для ключа в теге, который вы используете для определения охвата ресурса, должна начинаться с префикса Devops-guru-. Ключ тега может быть DevOps-Guru-deployment-application или devops-guru-rds-application. При создании ключа регистр символов в ключе может быть любым. После создания ключа он чувствителен к регистру. Например, DevOps Guru работает с ключом с именем devops-guru-rds и ключом с именем DevOps-Guru-RDS, и они действуют как два разных ключа. Возможные пары ключ/значение в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers.

TagValues -> (list)

Значения в коллекции тегов Amazon Web Services.

Значение тега — это необязательное поле, используемое для сопоставления строки с ключом тега (например, 111122223333, Production или имя команды). Ключ и значение — это ключевая пара тега. Опущение значения тега эквивалентно использованию пустой строки. Как и ключи тегов, значения тегов чувствительны к регистру. Можно указать не более 256 символов для значения тега.

(string)

ServiceCollection -> (structure)

Коллекция имен сервисов Amazon Web Services.

ServiceNames -> (list)

Массив строк, каждая из которых указывает имя сервиса Amazon Web Services.

(string)

ReactiveInsights -> (list)

Целое число, определяющее количество открытых реактивных инсайтов в вашей учетной записи Amazon Web Services.

(структура)

Информация о реактивном инсайте. Этот объект возвращается DescribeInsight.

Id -> (строка)

Идентификатор сводки инсайта.

AccountId -> (строка)

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

OrganizationalUnitId -> (строка)

Идентификатор организационной единицы.

Name -> (строка)

Имя сводки инсайта.

Severity -> (строка)

Массив значений степени серьезности, используемых для поиска инсайтов. Для получения дополнительной информации см. Раздел «Понимание степеней серьезности инсайтов» в руководстве пользователя Amazon DevOps Guru.

Status -> (строка)

Массив значений статуса, используемых для поиска инсайтов.

InsightTimeRange -> (структура)

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

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

Время начала поведения, описанного в инсайте.

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

Время окончания поведения, описанного в инсайте.

ResourceCollection -> (структура)

Коллекция ресурсов Amazon Web Services, поддерживаемых DevOps Guru. Два типа поддерживаемых коллекций ресурсов Amazon Web Services — это стеки Amazon Web Services CloudFormation и ресурсы Amazon Web Services, содержащие те же тэги Amazon Web Services. DevOps Guru может быть настроен на анализ ресурсов Amazon Web Services, определённых в стеках или помеченных тем же тэгом ключ. Вы можете указать до 500 стеков Amazon Web Services CloudFormation.

CloudFormation -> (структура)

Массив имён стеков Amazon Web Services CloudFormation. Стеки определяют ресурсы Amazon Web Services, которые анализирует DevOps Guru. Вы можете указать до 500 стеков Amazon Web Services CloudFormation.

StackNames -> (список)

Массив имён стеков CloudFormation.

(строка)

Tags -> (список)

Тэги Amazon Web Services, используемые ресурсами в коллекции ресурсов.

Тэги помогают идентифицировать и организовывать ваши ресурсы Amazon Web Services. Многие сервисы Amazon Web Services поддерживают тэги, поэтому вы можете назначить один и тот же тэг ресурсам из разных сервисов, чтобы указать, что ресурсы связаны. Например, вы можете назначить один и тот же тэг ресурсу таблицы Amazon DynamoDB и функции Lambda. Дополнительную информацию об использовании тэгов см. в информационном документе о лучших практиках по использованию тэгов.

Каждый тэг Amazon Web Services имеет две части.

  • Ключ тэга (например, CostCenter , Environment , Project или Secret ). Ключи тэгов чувствительны к регистру.
  • Необязательное поле, известное как значение тэга (например, 111122223333 , Production или имя команды). Опускание значения тэга эквивалентно использованию пустой строки. Как и ключи тэгов, значения тэгов чувствительны к регистру.

Вместе они известны как пары ключ-значение.

Предупреждение

Строка, используемая в качестве ключа в тэге, используемом для определения охвата ресурсов, должна начинаться с префикса Devops-guru- . Ключ тэга может быть DevOps-Guru-deployment-application или devops-guru-rds-application . При создании ключа регистр символов в ключе может быть любым. После создания ключ чувствителен к регистру. Например, DevOps Guru работает с ключом, названным devops-guru-rds , и ключом, названным DevOps-Guru-RDS , и они действуют как два разных ключа. Возможные пары ключ/значение в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers .

(структура)

Коллекция тэгов Amazon Web Services.

Тэги помогают идентифицировать и организовывать ваши ресурсы Amazon Web Services. Многие сервисы Amazon Web Services поддерживают тэги, поэтому вы можете назначить один и тот же тэг ресурсам из разных сервисов, чтобы указать, что ресурсы связаны. Например, вы можете назначить один и тот же тэг ресурсу таблицы Amazon DynamoDB и функции Lambda. Дополнительную информацию об использовании тэгов см. в информационном документе о лучших практиках по использованию тэгов.

Каждый тэг Amazon Web Services имеет две части.

  • Ключ тэга (например, CostCenter , Environment , Project или Secret ). Ключи тэгов чувствительны к регистру.
  • Необязательное поле, известное как значение тэга (например, 111122223333 , Production или имя команды). Опускание значения тэга эквивалентно использованию пустой строки. Как и ключи тэгов, значения тэгов чувствительны к регистру.

Вместе они известны как пары ключ-значение.

Предупреждение

Строка, используемая в качестве ключа в тэге, используемом для определения охвата ресурсов, должна начинаться с префикса Devops-guru- . Ключ тэга может быть DevOps-Guru-deployment-application или devops-guru-rds-application . При создании ключа регистр символов в ключе может быть любым. После создания ключ чувствителен к регистру. Например, DevOps Guru работает с ключом, названным devops-guru-rds , и ключом, названным DevOps-Guru-RDS , и они действуют как два разных ключа. Возможные пары ключ/значение в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers .

AppBoundaryKey -> (строка)

Ключ тэга Amazon Web Services, используемый для идентификации ресурсов Amazon Web Services, которые анализирует DevOps Guru. Все ресурсы Amazon Web Services в вашей учетной записи и регионе, помеченные этим ключом, составляют границу приложения и анализа DevOps Guru.

Предупреждение

Строка, используемая в качестве ключа в тэге, используемом для определения охвата ресурсов, должна начинаться с префикса Devops-guru- . Ключ тэга может быть DevOps-Guru-deployment-application или devops-guru-rds-application . При создании ключа регистр символов в ключе может быть любым. После создания ключ чувствителен к регистру. Например, DevOps Guru работает с ключом, названным devops-guru-rds , и ключом, названным DevOps-Guru-RDS , и они действуют как два разных ключа. Возможные пары ключ/значение в вашем приложении могут быть Devops-Guru-production-application/RDS или Devops-Guru-production-application/containers .

TagValues -> (список)

Значения в коллекции тэгов Amazon Web Services.

Значение тэга — это необязательное поле, используемое для ассоциации строки с ключом тэга (например, 111122223333 , Production или имя команды). Ключ и значение — это пара ключ-значение тэга. Опускание значения тэга эквивалентно использованию пустой строки. Как и ключи тэгов, значения тэгов чувствительны к регистру. Для значения тэга можно указать максимум 256 символов.

(строка)

ServiceCollection -> (структура)

Коллекция имён сервисов Amazon Web Services.

ServiceNames -> (список)

Массив строк, каждая из которых указывает имя сервиса Amazon Web Services.

(строка)

NextToken -> (строка)

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

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

Spec-Zone.ru

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