Spec-Zone.ru › AWS CLI v2

[ aws . ssm-incidents ]

list-incident-records

Описание

Отображает все записи об инцидентах в вашей учетной записи. Используйте эту команду для получения Amazon Resource Name (ARN) записи об инциденте, которую вы хотите обновить.

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

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

Синтаксис

  list-incident-records
[--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]

Параметры

--filters (список)

Фильтрует список записей об инцидентах, которые вы хотите просмотреть. Вы можете фильтровать по следующим ключам:

  • creationTime
  • impact
  • status
  • createdBy

Обратите внимание на следующее, когда вы используете фильтры:

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

(структура)

Фильтруйте выбор, используя условие.

condition -> (структура помеченных союзов)

Условие принимает значение до или после указанного времени, равно строке или равно целому числу.

Примечание

Это структура помеченных союзов. Может быть установлено только одно из следующих ключевых слов верхнего уровня: after, before, equals.

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

После указанной метки времени.

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

До указанной метки времени

equals -> (структура помеченных союзов)

Значение равно указанной строке или целому числу.

Примечание

Это структура помеченных союзов. Может быть установлено только одно из следующих ключевых слов верхнего уровня: integerValues, stringValues.

integerValues -> (список)

Список целочисленных значений, которым соответствует фильтр.

(целое число)

stringValues -> (список)

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

(строка)

key -> (строка)

Ключ, по которому вы фильтруете.

Синтаксис JSON:

[
  {
    "condition": {
      "after": timestamp,
      "before": timestamp,
      "equals": {
        "integerValues": [integer, ...],
        "stringValues": ["string", ...]
      }
    },
    "key": "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
  • текст
  • таблица
  • 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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

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

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

Чтобы перечислить записи об инцидентах

Следующий command-name пример перечисляет записи об инцидентах в вашей учетной записи Amazon Web Services.

aws ssm-incidents list-incident-records

Вывод:

{
    "incidentRecordSummaries": [
        {
            "arn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308",
            "creationTime": "2021-05-21T18:16:57.579000+00:00",
            "impact": 5,
            "incidentRecordSource": {
                "createdBy": "arn:aws:iam::111122223333:user/draliatp",
                "invokedBy": "arn:aws:iam::111122223333:user/draliatp",
                "source": "aws.ssm-incidents.custom"
            },
            "status": "OPEN",
            "title": "Example-Incident"
        }
    ]
}

Дополнительную информацию см. в разделе Список инцидентов в Руководстве пользователя Incident Manager.

Вывод

incidentRecordSummaries -> (список)

Подробности каждой перечисленной записи об инциденте.

(структура)

Подробности, описывающие запись об инциденте.

arn -> (строка)

Amazon Resource Name (ARN) инцидента.

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

Метка времени создания инцидента.

impact -> (целое число)

Определяет влияние на клиентов и приложения.

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

Причина, по которой Incident Manager создал инцидент.

createdBy -> (строка)

Сущность, которая инициировала инцидент.

invokedBy -> (строка)

Служебная сущность, которая приняла роль, указанную в createdBy. Если никакая служебная сущность не приняла роль, это поле будет пустым.

resourceArn -> (строка)

Ресурс, который стал причиной создания инцидента.

source -> (строка)

Сервис, который инициировал инцидент. Он может быть создан вручную в Incident Manager, автоматически создан с помощью сигнала тревоги Amazon CloudWatch или события Amazon EventBridge.

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

Метка времени разрешения инцидента.

status -> (строка)

Текущий статус инцидента.

title -> (строка)

Название инцидента. Это значение либо предоставляется планом реагирования, либо перезаписывается при создании.

nextToken -> (строка)

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

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

Spec-Zone.ru

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