Spec-Zone.ru › AWS CLI v2

[ aws . wellarchitected ]

update-workload

Описание

Обновить существующую рабочую нагрузку.

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

Синтаксис

  update-workload
--workload-id <value>
[--workload-name <value>]
[--description <value>]
[--environment <value>]
[--account-ids <value>]
[--aws-regions <value>]
[--non-aws-regions <value>]
[--pillar-priorities <value>]
[--architectural-design <value>]
[--review-owner <value>]
[--is-review-owner-update-acknowledged | --no-is-review-owner-update-acknowledged]
[--industry-type <value>]
[--industry <value>]
[--notes <value>]
[--improvement-status <value>]
[--discovery-config <value>]
[--applications <value>]
[--jira-configuration <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 (строка)

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

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

Имя рабочей нагрузки.

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

--description (строка)

Описание рабочей нагрузки.

--environment (строка)

Среда рабочей нагрузки.

Возможные значения:

  • PRODUCTION
  • PREPRODUCTION

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

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

(строка)

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

Синтаксис:

"string" "string" ...

--aws-regions (список)

Список регионов Amazon Web Services, связанных с рабочей нагрузкой, например, us-east-2 или ca-central-1.

(строка)

Регион Amazon Web Services, например, us-west-2 или ap-northeast-1.

Синтаксис:

"string" "string" ...

--non-aws-regions (список)

Список регионов, не относящихся к Amazon Web Services, связанных с рабочей нагрузкой.

(строка)

Синтаксис:

"string" "string" ...

--pillar-priorities (список)

Приоритеты столбцов, которые используются для упорядочивания элементов в плане улучшения. Каждый столбец представлен его PillarReviewSummary$PillarId.

(строка)

Идентификатор, используемый для идентификации столбца, например, security.

Столбец идентифицируется по его PillarReviewSummary$PillarId.

Синтаксис:

"string" "string" ...

--architectural-design (строка)

URL архитектурного проекта для рабочей нагрузки.

--review-owner (строка)

Владелец обзора рабочей нагрузки. Имя, адрес электронной почты или идентификатор основного отдела или лица, ответственного за процесс обзора рабочей нагрузки.

--is-review-owner-update-acknowledged | --no-is-review-owner-update-acknowledged (булево)

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

Если Владелец обзора не будет добавлен к рабочей нагрузке в течение 60 дней после подтверждения, доступ к рабочей нагрузке будет ограничен до тех пор, пока владелец не будет добавлен.

--industry-type (строка)

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

Если указано, должно быть одним из следующих:

  • Agriculture
  • Automobile
  • Defense
  • Design and Engineering
  • Digital Advertising
  • Education
  • Environmental Protection
  • Financial Services
  • Gaming
  • General Public Services
  • Healthcare
  • Hospitality
  • InfoTech
  • Justice and Public Safety
  • Life Sciences
  • Manufacturing
  • Media & Entertainment
  • Mining & Resources
  • Oil & Gas
  • Power & Utilities
  • Professional Services
  • Real Estate & Construction
  • Retail & Wholesale
  • Social Protection
  • Telecommunications
  • Travel, Transportation & Logistics
  • Other

--industry (строка)

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

--notes (строка)

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

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

--improvement-status (строка)

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

Возможные значения:

  • NOT_APPLICABLE
  • NOT_STARTED
  • IN_PROGRESS
  • COMPLETE
  • RISK_ACKNOWLEDGED

--discovery-config (структура)

Настройки конфигурации обнаружения Well-Architected, которые нужно связать с рабочей нагрузкой.

TrustedAdvisorIntegrationStatus -> (строка)

Статус интеграции с Trusted Advisor по отношению к рабочей нагрузке.

WorkloadResourceDefinition -> (список)

Режим идентификации ресурсов, связанных с рабочей нагрузкой.

Вы можете указать WORKLOAD_METADATA, APP_REGISTRY или оба.

(строка)

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

TrustedAdvisorIntegrationStatus=string,WorkloadResourceDefinition=string,string

JSON-синтаксис:

{
  "TrustedAdvisorIntegrationStatus": "ENABLED"|"DISABLED",
  "WorkloadResourceDefinition": ["WORKLOAD_METADATA"|"APP_REGISTRY", ...]
}

--applications (список)

Список ARNs приложений AppRegistry, которые нужно связать с рабочей нагрузкой.

(строка)

Синтаксис:

"string" "string" ...

--jira-configuration (структура)

Настройка интеграции с Jira.

IssueManagementStatus -> (строка)

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

IssueManagementType -> (строка)

Тип управления задачами Jira на уровне рабочей нагрузки.

JiraProjectKey -> (строка)

Ключ проекта Jira для синхронизации рабочих нагрузок.

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

IssueManagementStatus=string,IssueManagementType=string,JiraProjectKey=string

JSON-синтаксис:

{
  "IssueManagementStatus": "ENABLED"|"DISABLED"|"INHERIT",
  "IssueManagementType": "AUTO"|"MANUAL",
  "JiraProjectKey": "string"
}

--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
  • таблица
  • 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.

Вывод

Рабочая нагрузка -> (структура)

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

WorkloadId -> (строка)

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

WorkloadArn -> (строка)

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

WorkloadName -> (строка)

Имя рабочей нагрузки.

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

Описание -> (строка)

Описание рабочей нагрузки.

Среда -> (строка)

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

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

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

AccountIds -> (список)

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

(строка)

Идентификатор аккаунта Amazon Web Services.

AwsRegions -> (список)

Список регионов Amazon Web Services, связанных с рабочей нагрузкой, например, us-east-2 или ca-central-1 .

(строка)

Регион Amazon Web Services, например, us-west-2 или ap-northeast-1 .

NonAwsRegions -> (список)

Список регионов, не являющихся регионами Amazon Web Services, связанных с рабочей нагрузкой.

(строка)

АрхитектурныйПроект -> (строка)

URL архитектурного проекта для рабочей нагрузки.

ВладелецОбзора -> (строка)

Владелец обзора рабочей нагрузки. Имя, адрес электронной почты или идентификатор основной группы или лица, которые владеют процессом обзора рабочей нагрузки.

ДатаОграниченияОбзора -> (метка времени)

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

IsReviewOwnerUpdateAcknowledged -> (булево)

Флаг, указывающий, признал ли владелец рабочей нагрузки, что поле Владелец обзора обязательно.

Если Владелец обзора не добавлен к рабочей нагрузке в течение 60 дней после подтверждения, доступ к рабочей нагрузке ограничен до тех пор, пока владелец не будет добавлен.

ТипОтрасли -> (строка)

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

Если указано, должно быть одним из следующих:

  • Agriculture
  • Automobile
  • Defense
  • Design and Engineering
  • Digital Advertising
  • Education
  • Environmental Protection
  • Financial Services
  • Gaming
  • General Public Services
  • Healthcare
  • Hospitality
  • InfoTech
  • Justice and Public Safety
  • Life Sciences
  • Manufacturing
  • Media & Entertainment
  • Mining & Resources
  • Oil & Gas
  • Power & Utilities
  • Professional Services
  • Real Estate & Construction
  • Retail & Wholesale
  • Social Protection
  • Telecommunications
  • Travel, Transportation & Logistics
  • Other

Отрасль -> (строка)

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

Примечания -> (строка)

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

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

СтатусУлучшений -> (строка)

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

RiskCounts -> (карта)

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

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

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

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

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

PillarPriorities -> (список)

Приоритеты столпов, которые используются для упорядочения элементов в плане улучшений. Каждый столп представлен его PillarReviewSummary$PillarId .

(строка)

Идентификатор, используемый для идентификации столпа, например, security .

Столбец идентифицируется по его PillarReviewSummary$PillarId .

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 .

Владелец -> (строка)

Идентификатор аккаунта Amazon Web Services.

ShareInvitationId -> (строка)

Идентификатор, назначенный приглашению на совместное использование.

Теги -> (карта)

Теги, связанные с рабочей нагрузкой.

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

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

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

Настройка обнаружения, связанная с рабочей нагрузкой.

TrustedAdvisorIntegrationStatus -> (строка)

Статус интеграции обнаружения по отношению к Trusted Advisor для рабочей нагрузки.

WorkloadResourceDefinition -> (список)

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

Вы можете указать WORKLOAD_METADATA , APP_REGISTRY или оба.

(строка)

Приложения -> (список)

Список ARN приложений AppRegistry, связанных с рабочей нагрузкой.

(строка)

Профили -> (список)

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

(структура)

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

ProfileArn -> (строка)

ARN профиля.

ProfileVersion -> (строка)

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

PrioritizedRiskCounts -> (карта)

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

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

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

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

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

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

Настройка Jira для определённой рабочей нагрузки.

IssueManagementStatus -> (строка)

Уровень рабочей нагрузки: статус управления проблемами Jira.

IssueManagementType -> (строка)

Уровень рабочей нагрузки: тип управления проблемами Jira.

JiraProjectKey -> (строка)

Уровень рабочей нагрузки: ключ проекта Jira для синхронизации рабочих нагрузок.

StatusMessage -> (строка)

Уровень рабочей нагрузки: сообщение о состоянии настройки интеграции Jira.

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

Spec-Zone.ru

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