Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

update-ops-item

Описание

Редактирование или изменение OpsItem. Вам необходимо иметь разрешения в Identity and Access Management (IAM) для обновления OpsItem. Дополнительную информацию см. в разделе Настройка OpsCenter в руководстве пользователя Amazon Web Services Systems Manager.

Инженеры по работе с операционной системой и специалисты по ИТ используют Amazon Web Services Systems Manager OpsCenter для просмотра, анализа и устранения операционных проблем, влияющих на производительность и работоспособность ресурсов Amazon Web Services. Дополнительную информацию см. в разделе Amazon Web Services Systems Manager OpsCenter в руководстве пользователя Amazon Web Services Systems Manager.

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

Синтаксис

  update-ops-item
[--description <value>]
[--operational-data <value>]
[--operational-data-to-delete <value>]
[--notifications <value>]
[--priority <value>]
[--related-ops-items <value>]
[--status <value>]
--ops-item-id <value>
[--title <value>]
[--category <value>]
[--severity <value>]
[--actual-start-time <value>]
[--actual-end-time <value>]
[--planned-start-time <value>]
[--planned-end-time <value>]
[--ops-item-arn <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]

Параметры

--description (строка)

Пользовательский текст, содержащий информацию об OpsItem в формате Markdown.

--operational-data (карта)

Добавление новых ключей или изменение существующих пар «ключ-значение» карты OperationalData в объекте OpsItem.

Операционные данные — это пользовательские данные, предоставляющие полезные справочные сведения об OpsItem. Например, вы можете указать файлы журналов, строки ошибок, лицензионные ключи, советы по устранению неполадок или другие релевантные данные. Вы вводите операционные данные в виде пар «ключ-значение». Максимальная длина ключа составляет 128 символов. Максимальный размер значения составляет 20 КБ.

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

Ключи операционных данных не могут начинаться со следующих: amazon , aws , amzn , ssm , /amazon , /aws , /amzn , /ssm .

Вы можете сделать данные доступными для поиска другими пользователями в аккаунте или ограничить доступ к поиску. Поисковые данные означают, что все пользователи с доступом к странице обзора OpsItem (как предоставляется операцией DescribeOpsItems API) могут просматривать и искать указанные данные. Операционные данные, которые недоступны для поиска, видны только пользователям, имеющим доступ к OpsItem (как предоставляется операцией GetOpsItem API).

Используйте ключ /aws/resources в OperationalData, чтобы указать связанный ресурс в запросе. Используйте ключ /aws/automations в OperationalData, чтобы связать OpsItem с Automation runbook. Примеры команд AWS CLI, использующих эти ключи, см. в разделе Ручное создание OpsItem в руководстве пользователя Amazon Web Services Systems Manager.

ключ -> (строка)

значение -> (структура)

Объект, определяющий значение ключа и его тип в карте OperationalData.

Значение -> (строка)

Значение ключа OperationalData.

Тип -> (строка)

Тип пары «ключ-значение». Допустимые типы включают SearchableString и String .

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

KeyName1=Value=string,Type=string,KeyName2=Value=string,Type=string

Синтаксис JSON:

{"string": {
      "Value": "string",
      "Type": "SearchableString"|"String"
    }
  ...}

--operational-data-to-delete (список)

Ключи, которые вы хотите удалить из карты OperationalData.

(строка)

Синтаксис:

"string" "string" ...

--notifications (список)

Amazon Resource Name (ARN) темы SNS, в которую отправляются уведомления при редактировании или изменении этого OpsItem.

(структура)

Уведомление об OpsItem.

Arn -> (строка)

Amazon Resource Name (ARN) темы Amazon Simple Notification Service (Amazon SNS), в которую отправляются уведомления при редактировании или изменении данного OpsItem.

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

Arn=string ...

Синтаксис JSON:

[
  {
    "Arn": "string"
  }
  ...
]

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

Важность OpsItem по отношению к другим OpsItems в системе.

--related-ops-items (список)

Один или несколько OpsItems, которые имеют что-то общее с текущим OpsItem. Например, связанные OpsItems могут включать OpsItems с похожими сообщениями об ошибках, затронутыми ресурсами или состояниями затронутого ресурса.

(структура)

OpsItems, имеющие что-то общее с текущим OpsItem. Например, связанные OpsItems могут включать OpsItems с похожими сообщениями об ошибках, затронутыми ресурсами или состояниями затронутого ресурса.

OpsItemId -> (строка)

Идентификатор OpsItem, связанного с текущим OpsItem.

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

OpsItemId=string ...

Синтаксис JSON:

[
  {
    "OpsItemId": "string"
  }
  ...
]

--status (строка)

Статус OpsItem. Дополнительную информацию см. в разделе Редактирование деталей OpsItem в руководстве пользователя Amazon Web Services Systems Manager.

Возможные значения:

  • Open
  • InProgress
  • Resolved
  • Pending
  • TimedOut
  • Cancelling
  • Cancelled
  • Failed
  • CompletedWithSuccess
  • CompletedWithFailure
  • Scheduled
  • RunbookInProgress
  • PendingChangeCalendarOverride
  • ChangeCalendarOverrideApproved
  • ChangeCalendarOverrideRejected
  • PendingApproval
  • Approved
  • Revoked
  • Rejected
  • Closed

--ops-item-id (строка)

Идентификатор OpsItem.

--title (строка)

Краткое заголовок, описывающий характер OpsItem и затронутый ресурс.

--category (строка)

Укажите новую категорию для OpsItem.

--severity (строка)

Укажите новую степень серьезности для OpsItem.

--actual-start-time (метка времени)

Время запуска потока рабочего процесса runbook. В настоящее время сообщается только для типа OpsItem /aws/changerequest .

--actual-end-time (метка времени)

Время окончания потока рабочего процесса runbook. В настоящее время сообщается только для типа OpsItem /aws/changerequest .

--planned-start-time (метка времени)

Время, указанное в запросе на изменение, для запуска потока рабочего процесса runbook. В настоящее время поддерживается только для типа OpsItem /aws/changerequest .

--planned-end-time (метка времени)

Время, указанное в запросе на изменение, для окончания потока рабочего процесса runbook. В настоящее время поддерживается только для типа OpsItem /aws/changerequest .

--ops-item-arn (строка)

Amazon Resource Name (ARN) OpsItem.

--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 (строка)

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

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

Примеры

Примечание

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

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

Для обновления элемента OpsItem

Следующий update-ops-item пример обновляет описание, приоритет и категорию элемента OpsItem. Кроме того, команда указывает тему SNS, в которую отправляются уведомления при редактировании или изменении этого элемента OpsItem.

aws ssm update-ops-item \
    --ops-item-id "oi-287b5EXAMPLE" \
    --description "Primary OpsItem for failover event 2020-01-01-fh398yf" \
    --priority 2 \
    --category "Security" \
    --notifications "Arn=arn:aws:sns:us-east-2:111222333444:my-us-east-2-topic"

Вывод:

This command produces no output.

Дополнительную информацию см. в разделе Работа с элементами OpsItem в Руководстве пользователя AWS Systems Manager.

Вывод

Нет

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

Spec-Zone.ru

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