get-ops-summary

Описание

Просмотр сводки метаданных операций (OpsData) на основе указанных фильтров и агрегаторов. OpsData может включать информацию о рабочих элементах (OpsItems) операционной работы Amazon Web Services Systems Manager OpsCenter, а также информацию о любом решении или сервисе Amazon Web Services, настроенном на отправку OpsData в Amazon Web Services Systems Manager Explorer.

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

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

Синтаксис

  get-ops-summary
[--sync-name <value>]
[--filters <value>]
[--aggregators <value>]
[--result-attributes <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]

Параметры

--sync-name (строка)

Укажите имя синхронизации данных ресурсов, которое нужно получить.

--filters (список)

Необязательные фильтры, используемые для сужения возвращаемых данных OpsData.

(структура)

Фильтр для просмотра сводок OpsData.

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

Имя фильтра.

Значения -> (список)

Значение фильтра.

(строка)

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

Тип фильтра.

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

Key=string,Values=string,string,Type=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...],
    "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
  }
  ...
]

--aggregators (список)

Необязательные агрегаторы, возвращающие количество OpsData на основе одного или нескольких выражений.

(структура)

Один или несколько агрегаторов для просмотра количества OpsData с использованием различных измерений, таких как Source , CreatedTime или Source and CreatedTime, чтобы назвать некоторые.

AggregatorType -> (строка)

Агрегатор типа Range или Count для ограничения сводки OpsData.

TypeName -> (строка)

Имя типа данных для просмотра количества OpsData.

AttributeName -> (строка)

Имя атрибута OpsData, по которому ограничить количество OpsData.

Values -> (карта)

Значение агрегатора.

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

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

Filters -> (список)

Фильтры агрегатора.

(структура)

Фильтр для просмотра сводок OpsData.

Key -> (строка)

Имя фильтра.

Values -> (список)

Значение фильтра.

(строка)

Type -> (строка)

Тип фильтра.

Aggregators -> (список)

Вложенный агрегатор для просмотра количества OpsData.

(структура)

AggregatorType -> (строка)

Агрегатор типа Range или Count для ограничения сводки OpsData.

TypeName -> (строка)

Имя типа данных для просмотра количества OpsData.

AttributeName -> (строка)

Имя атрибута OpsData, по которому ограничить количество OpsData.

Values -> (карта)

Значение агрегатора.

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

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

Filters -> (список)

Фильтры агрегатора.

(структура)

Фильтр для просмотра сводок OpsData.

Key -> (строка)

Имя фильтра.

Values -> (список)

Значение фильтра.

(строка)

Type -> (строка)

Тип фильтра.

Синтаксис JSON:

[
  {
    "AggregatorType": "string",
    "TypeName": "string",
    "AttributeName": "string",
    "Values": {"string": "string"
      ...},
    "Filters": [
      {
        "Key": "string",
        "Values": ["string", ...],
        "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
      }
      ...
    ],
    "Aggregators": [
      {
        "AggregatorType": "string",
        "TypeName": "string",
        "AttributeName": "string",
        "Values": {"string": "string"
          ...},
        "Filters": [
          {
            "Key": "string",
            "Values": ["string", ...],
            "Type": "Equal"|"NotEqual"|"BeginWith"|"LessThan"|"GreaterThan"|"Exists"
          }
          ...
        ],
        "Aggregators":
      }
      ...
    ]
  }
  ...
]

--result-attributes (список)

Тип данных OpsData для возврата.

(структура)

Тип данных OpsItem для возврата.

TypeName -> (строка)

Имя типа данных. Допустимые значения: AWS:OpsItem , AWS:EC2InstanceInformation , AWS:OpsItemTrendline или AWS:ComplianceSummary.

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

TypeName=string ...

Синтаксис JSON:

[
  {
    "TypeName": "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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для просмотра сводки всех OpsItems

Следующий пример get-ops-summary отображает сводку всех OpsItems в вашей учётной записи AWS.

aws ssm get-ops-summary

Вывод:

{
    "Entities": [
        {
            "Id": "oi-4309fEXAMPLE",
            "Data": {
                "AWS:OpsItem": {
                    "CaptureTime": "2020-02-26T18:58:32.918Z",
                    "Content": [
                        {
                            "AccountId": "111222333444",
                            "Category": "Availability",
                            "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
                            "CreatedTime": "2020-02-26T19:10:44.149Z",
                            "Description": "CloudWatch Event Rule SSMOpsItems-EC2-instance-terminated was triggered. Your EC2 instance has terminated. See below for more details.",
                            "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
                            "LastModifiedTime": "2020-02-26T19:10:44.149Z",
                            "Notifications": "",
                            "OperationalData": "{\"/aws/automations\":{\"type\":\"SearchableString\",\"value\":\"[ { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedWindowsInstance\\\" }, { \\\"automationType\\\": \\\"AWS:SSM:Automation\\\", \\\"automationId\\\": \\\"AWS-CreateManagedLinuxInstance\\\" } ]\"},\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ec2:us-east-2:111222333444:instance/i-0acbd0800fEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-EC2-instance-terminated\\\"}\"}}",
                            "OpsItemId": "oi-4309fEXAMPLE",
                            "RelatedItems": "",
                            "Severity": "3",
                            "Source": "EC2",
                            "Status": "Open",
                            "Title": "EC2 instance terminated"
                        }
                    ]
                }
            }
        },
        {
            "Id": "oi-bb2a0e6a4541",
            "Data": {
                "AWS:OpsItem": {
                    "CaptureTime": "2019-11-26T19:20:06.161Z",
                    "Content": [
                        {
                            "AccountId": "111222333444",
                            "Category": "Availability",
                            "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
                            "CreatedTime": "2019-11-26T20:00:07.237Z",
                            "Description": "CloudWatch Event Rule SSMOpsItems-SSM-maintenance-window-execution-failed was triggered. Your SSM Maintenance Window execution has failed. See below for more details.",
                            "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
                            "LastModifiedTime": "2019-11-26T20:00:07.237Z",
                            "Notifications": "",
                            "OperationalData": "{\"/aws/resources\":{\"type\":\"SearchableString\",\"value\":\"[{\\\"arn\\\":\\\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-0e83ba440dEXAMPLE\\\"}]\"},\"/aws/dedup\":{\"type\":\"SearchableString\",\"value\":\"{\\\"dedupString\\\":\\\"SSMOpsItems-SSM-maintenance-window-execution-failed\\\"}\"}}",
                            "OpsItemId": "oi-bb2a0EXAMPLE",
                            "RelatedItems": "",
                            "Severity": "3",
                            "Source": "SSM",
                            "Status": "Open",
                            "Title": "SSM Maintenance Window execution failed"
                        }
                    ]
                }
            }
        }
    ]
}

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

Вывод

Сущности -> (список)

Список агрегированных данных и отфильтрованных OpsData.

(структура)

Результат запроса.

Id -> (строка)

Идентификатор запроса.

Данные -> (карта)

Данные, возвращенные запросом.

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

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

Сводка OpsData.

CaptureTime -> (строка)

Время захвата OpsData.

Содержание -> (список)

Подробности сводки OpsData.

(карта)

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

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

NextToken -> (строка)

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