Spec-Zone.ru › AWS CLI v2

[ aws . observabilityadmin ]

list-resource-telemetry-for-organization

Описание

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

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

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

Синтаксис

  list-resource-telemetry-for-organization
[--account-identifiers <value>]
[--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]

Параметры

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

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

(строка)

Синтаксис:

"string" "string" ...

--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 для вывода.

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

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

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

Отключить автоматический запрос параметров CLI.

Примеры

Примечание

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

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

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

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

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

Вывод:

{
    "TelemetryConfigurations": [
        {
            "AccountIdentifier": "111111111111",
            "TelemetryConfigurationState": {
                "Logs": "NotApplicable",
                "Metrics": "Disabled",
                "Traces": "NotApplicable"
            },
            "ResourceType": "AWS::EC2::Instance",
            "ResourceIdentifier": "i-a166400b",
            "ResourceTags": {
                "Name": "dev"
            },
            "LastUpdateTimeStamp": 1733168548521
        },
        {
            "AccountIdentifier": "222222222222",
            "TelemetryConfigurationState": {
                "Logs": "NotApplicable",
                "Metrics": "Disabled",
                "Traces": "NotApplicable"
            },
            "ResourceType": "AWS::EC2::Instance",
            "ResourceIdentifier": "i-b188560f",
            "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