Spec-Zone.ru › AWS CLI v2

[ aws . codeguruprofiler ]

list-profiling-groups

Описание

Возвращает список профилируемых групп. Профилируемые группы возвращаются как объекты ` ProfilingGroupDescription https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html`__.

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

Синтаксис

  list-profiling-groups
[--include-description | --no-include-description]
[--max-results <value>]
[--next-token <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]

Параметры

--include-description | --no-include-description (логическое значение)

Значение, указывающее, следует ли включать описание. Если значение true , то возвращается список объектов ` ProfilingGroupDescription https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html`__ содержащих подробную информацию о профилируемых группах. Если false , то возвращается список имён профилируемых групп.

--max-results (целое число)

Максимальное количество результатов профилируемых групп, возвращаемых ListProfilingGroups при постраничном выводе. Когда этот параметр используется, ListProfilingGroups возвращает только maxResults результатов на одной странице вместе с элементом ответа nextToken . Остальные результаты начального запроса можно увидеть, отправив другой запрос ListProfilingGroups с возвращённым значением nextToken.

--next-token (строка)

Значение nextToken , возвращённое предыдущим постраничным запросом ListProfilingGroups, где использовался параметр maxResults и результаты превысили значение этого параметра. Выдача продолжается с конца предыдущих результатов, которые вернули значение nextToken.

Примечание

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

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

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

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое значение)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

nextToken -> (строка)

Значение nextToken, которое следует включить в последующий запрос ListProfilingGroups. Когда результаты запроса ListProfilingGroups превышают maxResults, это значение может быть использовано для получения следующей страницы результатов. Это значение является null, когда больше результатов для возврата нет.

profilingGroupNames -> (список)

Возвращённый список имён профилируемых групп. Список имён возвращается только если includeDescription false, в противном случае возвращается список объектов ` ProfilingGroupDescription https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html`__.

(строка)

profilingGroups -> (список)

Возвращённый список объектов ` ProfilingGroupDescription https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html`__. Список объектов ` ProfilingGroupDescription https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html`__ возвращается только если includeDescription равно true, в противном случае возвращается список имён профилируемых групп.

(структура)

Содержит информацию о профилируемой группе.

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

Объект ` AgentOrchestrationConfig https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html`__ , указывающий, включена ли профилируемая группа для отслеживания или нет.

profilingEnabled -> (логическое значение)

Логическое значение, указывающее, собирает ли агент профилирования данные профилирования или нет. Установите значение true для включения профилирования.

arn -> (строка)

Уникальный идентификатор Amazon Resource Name (ARN), идентифицирующий ресурс профилируемой группы.

computePlatform -> (строка)

Вычислительная платформа профилируемой группы. Если значение установлено в AWSLambda, то профилируемое приложение запущено на AWS Lambda. Если значение установлено в Default, то профилируемое приложение запущено на вычислительной платформе, не являющейся AWS Lambda, например, Amazon EC2, локальном сервере или другой платформе. По умолчанию значение Default.

createdAt -> (временная метка)

Время создания профилируемой группы. Укажите в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z представляет собой 1 миллисекунду после 1 июня 2020 года в 13:15:02 по UTC.

name -> (строка)

Имя профилируемой группы.

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

Объект ` ProfilingStatus https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html`__ , который содержит информацию о последнем времени, когда агент профилирования отправил отчёт, о последнем полученном профиле, а также о периоде и времени начала последнего агрегированного профиля.

latestAgentOrchestratedAt -> (временная метка)

Дата и время, когда агент профилирования в последний раз отправлял отчёт. Укажите в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z представляет собой 1 миллисекунду после 1 июня 2020 года в 13:15:02 по UTC.

latestAgentProfileReportedAt -> (временная метка)

Дата и время, когда был получен последний профиль. Укажите в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z представляет собой 1 миллисекунду после 1 июня 2020 года в 13:15:02 по UTC.

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

Объект ` AggregatedProfileTime https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html`__ , содержащий период агрегирования и время начала агрегированного профиля.

period -> (строка)

Период агрегирования. Это указывает период, в течение которого агрегируемый профиль собирает опубликованные агентом профили для группы профилирования. Используйте один из трёх допустимых периодов, указанных в формате ISO 8601.

  • P1D — 1 день
  • PT1H — 1 час
  • PT5M — 5 минут

start -> (временная метка)

Время начала агрегирования опубликованных агентом профилей для группы профилирования. Агрегированный профиль содержит профили, опубликованные агентом, начиная с этого времени в течение периода агрегирования, указанного свойством period объекта AggregatedProfileTime.

Укажите start в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z представляет собой 1 миллисекунду после 1 июня 2020 года в 13:15:02 по UTC.

tags -> (карта)

Список тегов, относящихся к этой профилируемой группе.

key -> (строка)

value -> (строка)

updatedAt -> (временная метка)

Дата и время последнего обновления профилируемой группы. Укажите в формате ISO 8601. Например, 2020-06-01T13:15:02.001Z представляет собой 1 миллисекунду после 1 июня 2020 года в 13:15:02 по UTC.

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

Spec-Zone.ru

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