Spec-Zone.ru › AWS CLI v2

[ aws . observabilityadmin ]

list-resource-telemetry

Описание

Возвращает список конфигураций телеметрии для ресурсов AWS, поддерживаемых конфигурацией телеметрии. Для получения дополнительной информации см. Аудит конфигураций телеметрии CloudWatch.

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

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

Синтаксис

  list-resource-telemetry
[--resource-identifier-prefix <value>]
[--resource-types <value>]
[--telemetry-configuration-state <value>]
[--resource-tags <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]

Параметры

--resource-identifier-prefix (строка)

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

--resource-types (список)

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

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  AWS::EC2::Instance
  AWS::EC2::VPC
  AWS::Lambda::Function

--telemetry-configuration-state (массив)

Пара ключ-значение для фильтрации ресурсов на основе типа телеметрии и состояния конфигурации телеметрии. Ключ — это тип телеметрии, а значение — состояние.

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

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

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

  KeyName1=string,KeyName2=string

Where valid key names are:
  Logs
  Metrics
  Traces

Синтаксис JSON:

{"Logs"|"Metrics"|"Traces": "Enabled"|"Disabled"|"NotApplicable"
  ...}

--resource-tags (массив)

Пара ключ-значение для фильтрации ресурсов на основе тегов, связанных с ресурсом. Дополнительную информацию о тегах см. в разделе Что такое теги?

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"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
  • текст
  • таблица
  • 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.

Для получения конфигураций телеметрии для аккаунта

Следующий пример list-resource-telemetry возвращает список конфигураций телеметрии для ресурсов AWS, поддерживаемых конфигурацией телеметрии, в указанном аккаунте.

aws observabilityadmin list-resource-telemetry \
    --resource-types  AWS::EC2::Instance

Вывод:

{
    "TelemetryConfigurations": [
        {
            "AccountIdentifier": "111111111111",
            "TelemetryConfigurationState": {
                "Logs": "NotApplicable",
                "Metrics": "Disabled",
                "Traces": "NotApplicable"
            },
            "ResourceType": "AWS::EC2::Instance",
            "ResourceIdentifier": "i-0e979d278b040f856",
            "ResourceTags": {
                "Name": "apache"
            },
            "LastUpdateTimeStamp": 1732744260182
        }
    ]
}

Для получения дополнительной информации см. Аудит конфигураций телеметрии CloudWatch в Руководстве пользователя Amazon CloudWatch.

Вывод

TelemetryConfigurations -> (список)

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

(структура)

Модель, представляющая состояние ресурса в аккаунте в соответствии с конфигурацией телеметрии.

AccountIdentifier -> (строка)

Идентификатор аккаунта, содержащий ресурс, управляемый в конфигурации телеметрии. Пример допустимого идентификатора аккаунта — 012345678901.

TelemetryConfigurationState -> (массив)

Состояние конфигурации для ресурса, например { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }.

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

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

ResourceType -> (строка)

Тип ресурса, например AWS::EC2::Instance.

ResourceIdentifier -> (строка)

Идентификатор ресурса, например i-0b22a22eec53b9321.

ResourceTags -> (массив)

Теги, связанные с ресурсом, например { Name: "ExampleInstance", Environment: "Development" }.

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

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

LastUpdateTimeStamp -> (длинное целое число)

Отметка времени последнего изменения конфигурации телеметрии для ресурса. Например, 1728679196318.

NextToken -> (строка)

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

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

Spec-Zone.ru

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