Spec-Zone.ru › AWS CLI v2

[ aws . wellarchitected ]

list-workloads

Описание

Упорядоченный список рабочих нагрузок.

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

Синтаксис

  list-workloads
[--workload-name-prefix <value>]
[--next-token <value>]
[--max-results <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]

Параметры

--workload-name-prefix (строка)

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

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

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

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

Максимальное количество результатов, возвращаемых для данного запроса.

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

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

  • вкл
  • выкл
  • авто

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

Вывод

WorkloadSummaries -> (список)

Список сводных данных рабочих нагрузок.

(структура)

Объект возвращаемого сводного обзора рабочей нагрузки.

WorkloadId -> (строка)

Идентификатор, назначенный рабочей нагрузке. Этот идентификатор уникален в пределах региона Amazon Web Services.

WorkloadArn -> (строка)

ARN для рабочей нагрузки.

WorkloadName -> (строка)

Название рабочей нагрузки.

Название должно быть уникальным в рамках аккаунта в регионе Amazon Web Services. Пробелы и регистр при проверке на уникальность игнорируются.

Owner -> (строка)

Идентификатор учетной записи Amazon Web Services.

UpdatedAt -> (отметка времени)

Дата и время записи.

Lenses -> (список)

Список линз, связанных с рабочей нагрузкой. Каждая линза идентифицируется по своему LensSummary$LensAlias.

Если к рабочей нагрузке применён шаблон обзора, определяющий линзы, эти линзы применяются к рабочей нагрузке дополнительно к этим линзам.

(строка)

Псевдоним линзы.

Для официальных линз Amazon Web Services это либо псевдоним линзы, например, serverless, либо ARN линзы, например, arn:aws:wellarchitected:us-east-1::lens/serverless. Обратите внимание, что некоторые операции (например, ExportLens и CreateLensShare) запрещены для официальных линз Amazon Web Services.

Для пользовательских линз это ARN линзы, например, arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Каждая линза идентифицируется по своему LensSummary$LensAlias.

RiskCounts -> (карта)

Карта, связывающая имена рисков с количеством вопросов, имеющих этот рейтинг.

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

Риск для данной рабочей нагрузки, обзора линзы, столпа или вопроса.

значение -> (целое число)

Неотрицательное целое число, обозначающее количество.

ImprovementStatus -> (строка)

Статус улучшения для рабочей нагрузки.

Profiles -> (список)

Профиль, связанный с рабочей нагрузкой.

(структура)

Профиль, связанный с рабочей нагрузкой.

ProfileArn -> (строка)

ARN профиля.

ProfileVersion -> (строка)

Версия профиля.

PrioritizedRiskCounts -> (карта)

Карта, связывающая имена рисков с количеством вопросов, имеющих этот рейтинг.

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

Риск для данной рабочей нагрузки, обзора линзы, столпа или вопроса.

значение -> (целое число)

Неотрицательное целое число, обозначающее количество.

NextToken -> (строка)

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

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

Spec-Zone.ru

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