[ aws . wellarchitected ]
get-workload
Описание
Получить существующую рабочую нагрузку.
См. также: Документацию AWS API
Синтаксис
get-workload
--workload-id <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-id (строка)
--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.
Вывод
Рабочая нагрузка -> (структура)
Объект возвращаемой рабочей нагрузки.
WorkloadId -> (строка)
WorkloadArn -> (строка)
WorkloadName -> (строка)
Имя рабочей нагрузки.
Имя должно быть уникальным в рамках учетной записи в регионе Amazon Web Services. Пробелы и регистр при проверке уникальности игнорируются.
Описание -> (строка)
Среда -> (строка)
UpdatedAt -> (метка времени)
AccountIds -> (список)
Список идентификаторов учетных записей Amazon Web Services, связанных с рабочей нагрузкой.
(строка)
AwsRegions -> (список)
Список регионов Amazon Web Services, связанных с рабочей нагрузкой, например, us-east-2 или ca-central-1.
(строка)
us-west-2 или ap-northeast-1.NonAwsRegions -> (список)
Список регионов, не являющихся регионами Amazon Web Services, связанных с рабочей нагрузкой.
(строка)
ArchitecturalDesign -> (строка)
ReviewOwner -> (строка)
ReviewRestrictionDate -> (метка времени)
IsReviewOwnerUpdateAcknowledged -> (булево)
Флаг, указывающий, подтвердил ли владелец рабочей нагрузки, что поле Владелец обзора обязательно.
Если Владелец обзора не будет добавлен к рабочей нагрузке в течение 60 дней после подтверждения, доступ к рабочей нагрузке будет ограничен до тех пор, пока владелец не будет добавлен.
IndustryType -> (строка)
Тип отрасли для рабочей нагрузки.
Если указано, должно быть одним из следующих:
AgricultureAutomobileDefenseDesign and EngineeringDigital AdvertisingEducationEnvironmental ProtectionFinancial ServicesGamingGeneral Public ServicesHealthcareHospitalityInfoTechJustice and Public SafetyLife SciencesManufacturingMedia & EntertainmentMining & ResourcesOil & GasPower & UtilitiesProfessional ServicesReal Estate & ConstructionRetail & WholesaleSocial ProtectionTelecommunicationsTravel, Transportation & LogisticsOther
Отрасль -> (строка)
Примечания -> (строка)
Примечания, связанные с рабочей нагрузкой.
Для шаблона обзора это примечания, которые будут связаны с рабочей нагрузкой при применении шаблона.
Статус улучшений -> (строка)
RiskCounts -> (карта)
Карта от имен рисков до количества вопросов, имеющих такой рейтинг.
ключ -> (строка)
значение -> (целое число)
PillarPriorities -> (список)
Приоритеты столпов, используемые для упорядочивания элементов в плане улучшений. Каждый столп представлен его PillarReviewSummary$PillarId.
(строка)
Идентификатор, используемый для идентификации столпа, например, security.
Столп идентифицируется по его PillarReviewSummary$PillarId.
Линзы -> (список)
Список линз, связанных с рабочей нагрузкой. Каждая линза идентифицируется по её 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.
Владелец -> (строка)
ShareInvitationId -> (строка)
Теги -> (карта)
Теги, связанные с рабочей нагрузкой.
ключ -> (строка)
значение -> (строка)
DiscoveryConfig -> (структура)
Настройки обнаружения, связанные с рабочей нагрузкой.
TrustedAdvisorIntegrationStatus -> (строка)
WorkloadResourceDefinition -> (список)
Режим, используемый для определения ресурсов, связанных с рабочей нагрузкой.
Вы можете указать WORKLOAD_METADATA, APP_REGISTRY или оба.
(строка)
Приложения -> (список)
Список ARN приложений AppRegistry, связанных с рабочей нагрузкой.
(строка)
Профили -> (список)
Профиль, связанный с рабочей нагрузкой.
(структура)
Профиль, связанный с рабочей нагрузкой.
ProfileArn -> (строка)
ProfileVersion -> (строка)
PrioritizedRiskCounts -> (карта)
Карта от имен рисков до количества вопросов, имеющих такой рейтинг.
ключ -> (строка)
значение -> (целое число)
JiraConfiguration -> (структура)
Настройки Jira для конкретной рабочей нагрузки.
IssueManagementStatus -> (строка)
IssueManagementType -> (строка)
JiraProjectKey -> (строка)
StatusMessage -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.