Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

start-task

Описание

Запускает новую задачу из указанного определения задачи на указанном контейнерном экземпляре или экземплярах.

Примечание

21 марта 2024 года были внесены изменения для разрешения ревизии определения задачи перед авторизацией. Когда ревизия определения задачи не указана, авторизация будет происходить с использованием последней ревизии определения задачи.

Примечание

Amazon Elastic Inference (EI) больше недоступен для клиентов.

В качестве альтернативы, вы можете использовать ``RunTask``, чтобы размещать задачи за вас. Дополнительную информацию см. в разделе Расписание задач в Руководстве разработчика Amazon Elastic Container Service.

Вы можете подключить тома Amazon EBS к задачам Amazon ECS, настроив том при создании или обновлении сервиса. Дополнительную информацию см. в разделе Тома Amazon EBS в Руководстве разработчика Amazon Elastic Container Service.

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

Синопсис

  start-task
[--cluster <value>]
--container-instances <value>
[--enable-ecs-managed-tags | --no-enable-ecs-managed-tags]
[--enable-execute-command | --disable-execute-command]
[--group <value>]
[--network-configuration <value>]
[--overrides <value>]
[--propagate-tags <value>]
[--reference-id <value>]
[--started-by <value>]
[--tags <value>]
--task-definition <value>
[--volume-configurations <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]

Параметры

--cluster (строка)

Короткое имя или полное Amazon Resource Name (ARN) кластера, в котором необходимо запустить задачу. Если кластер не указан, используется по умолчанию.

--container-instances (список)

Идентификаторы экземпляров контейнера или полные записи ARN для экземпляров контейнеров, в которых вы хотите разместить задачу. Вы можете указать до 10 экземпляров контейнеров.

(строка)

Синтаксис:

"string" "string" ...

--enable-ecs-managed-tags | --no-enable-ecs-managed-tags (логическое значение)

Указывает, использовать ли управляемые Amazon ECS теги для задачи. Дополнительную информацию см. в разделе Разметка ресурсов Amazon ECS в Руководстве разработчика Amazon Elastic Container Service.

--enable-execute-command | --disable-execute-command (логическое значение)

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

--group (строка)

Имя группы задач, которая должна быть ассоциирована с задачей. Значение по умолчанию — имя семейства определения задачи (например, family:my-family-name).

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

Настройка подсети VPC и группы безопасности для задач, которые получают собственный эластичный сетевой интерфейс с использованием режима сети awsvpc.

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

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

Примечание

Все указанные подсети и группы безопасности должны быть из одной VPC.

subnets -> (список)

Идентификаторы подсетей, связанных с задачей или сервисом. Можно указать до 16 подсетей.

Примечание

Все указанные подсети должны быть из одной VPC.

(строка)

securityGroups -> (список)

Идентификаторы групп безопасности, связанных с задачей или сервисом. Если вы не укажете группу безопасности, используется группа безопасности по умолчанию для VPC. Можно указать до 5 групп безопасности.

Примечание

Все указанные группы безопасности должны быть из одной VPC.

(строка)

assignPublicIp -> (строка)

Получает ли эластичный сетевой интерфейс задачи публичный IP-адрес.

Учитывайте следующее при установке этого значения:

  • При использовании create-service или update-service значение по умолчанию — DISABLED.
  • Когда служба deploymentController находится в режиме ECS, значение должно быть DISABLED.

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

awsvpcConfiguration={subnets=[string,string],securityGroups=[string,string],assignPublicIp=string}

Синтаксис JSON:

{
  "awsvpcConfiguration": {
    "subnets": ["string", ...],
    "securityGroups": ["string", ...],
    "assignPublicIp": "ENABLED"|"DISABLED"
  }
}

--overrides (структура)

Список замещений контейнера в формате JSON, которые указывают имя контейнера в указанном определении задачи и замещения, которые он получает. Можно переопределить команду по умолчанию для контейнера (которая указана в определении задачи или образе Docker) с помощью замещения команды. Также можно переопределить существующие переменные среды (которые указаны в определении задачи или образе Docker) в контейнере или добавить новые переменные среды с помощью замещения переменных среды.

Примечание

Разрешено до 8192 символов для замещений. Это ограничение включает символы форматирования JSON структуры замещения.

containerOverrides -> (список)

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

(структура)

Замещения, которые отправляются контейнеру. Можно передать пустое замещение контейнера. Пример пустого замещения контейнера — {"containerOverrides": [ ] }. Если указано непустое замещение контейнера, параметр name должен быть включен.

Для хранения конфиденциальных данных можно использовать Secrets Manager или Amazon Web Services Systems Manager Parameter Store. Дополнительную информацию см. в Руководстве разработчика Amazon ECS — Получение секретов через переменные среды.

name -> (строка)

Имя контейнера, который получает замещение. Этот параметр обязателен, если указано какое-либо замещение.

command -> (список)

Команда, отправляемая контейнеру, которая переопределяет команду по умолчанию из образа Docker или определения задачи. Вы также должны указать имя контейнера.

(строка)

environment -> (список)

Переменные среды, которые нужно отправить контейнеру. Вы можете добавлять новые переменные среды, которые добавляются в контейнер при запуске, или переопределять существующие переменные среды из образа Docker или определения задачи. Вы также должны указать имя контейнера.

(структура)

Объект пары ключ-значение.

name -> (строка)

Имя пары ключ-значение. Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары ключ-значение. Для переменных среды это значение переменной среды.

environmentFiles -> (список)

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

(структура)

Список файлов, содержащих переменные среды для передачи контейнеру. Можно указать до десяти файлов переменных среды. Файл должен иметь расширение .env. Каждая строка в файле переменных среды должна содержать переменную среды в формате VARIABLE=VALUE. Строки, начинающиеся с #, обрабатываются как комментарии и игнорируются.

Если в определении контейнера указаны переменные среды с помощью параметра environment, они имеют приоритет над переменными, содержащимися в файле переменных среды. Если несколько файлов переменных среды содержат одну и ту же переменную, они обрабатываются сверху вниз. Рекомендуется использовать уникальные имена переменных. Дополнительную информацию см. в разделе Использование файла для передачи переменных среды контейнеру в Руководстве разработчика Amazon Elastic Container Service.

Файлы переменных среды являются объектами в Amazon S3, и все соображения безопасности Amazon S3 применяются.

Для типа запуска Fargate необходимо использовать следующие платформы:

  • Версия платформы Linux 1.4.0 или более поздняя.
  • Версия платформы Windows 1.0.0 или более поздняя.

Учитывайте следующее при использовании типа запуска Fargate:

  • Файл обрабатывается как собственный файл Docker env.
  • Обработка экранирования оболочки не поддерживается.
  • Точка входа контейнера интерпретирует значения VARIABLE.

value -> (строка)

Amazon Resource Name (ARN) объекта Amazon S3, содержащего файл переменных среды.

type -> (строка)

Тип файла для использования. Файлы переменных среды — это объекты в Amazon S3. Поддерживается только значение s3.

cpu -> (целое число)

Количество единиц cpu, зарезервированных для контейнера, вместо значения по умолчанию из определения задачи. Вы также должны указать имя контейнера.

memory -> (целое число)

Жесткий лимит памяти (в МБ) для контейнера, вместо значения по умолчанию из определения задачи. Если контейнер пытается превысить указанный здесь лимит памяти, контейнер убивается. Вы также должны указать имя контейнера.

memoryReservation -> (целое число)

Мягкий лимит памяти (в МБ) для резервирования для контейнера, вместо значения по умолчанию из определения задачи. Вы также должны указать имя контейнера.

resourceRequirements -> (список)

Тип и объем ресурса для назначения контейнеру, вместо значения по умолчанию из определения задачи. Поддерживается только ресурс GPU.

(структура)

Тип и количество ресурса для назначения контейнеру. Поддерживаемые типы ресурсов — GPU и ускорители Elastic Inference. Дополнительную информацию см. в разделе Работа с GPU в Amazon ECS или Работа с ускорителями Amazon Elastic Inference в Amazon ECS в Руководстве разработчика Amazon Elastic Container Service.

value -> (строка)

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

Когда тип — GPU, значение — количество физических GPUs, которое агент Amazon ECS контейнера резервирует для контейнера. Количество GPU, резервируемых для всех контейнеров в задаче, не может превышать количество доступных GPU на экземпляре контейнера, на котором запускается задача.

Когда тип — InferenceAccelerator, значение value соответствует значению deviceName для ускорителя InferenceAccelerator, указанного в определении задачи.

type -> (строка)

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

cpu -> (строка)

Переопределение процессора для задачи.

inferenceAcceleratorOverrides -> (список)

Переопределение ускорителя Elastic Inference для задачи.

(структура)

Подробная информация об определении переопределения задачи ускорителя Elastic Inference. Этот параметр используется для переопределения ускорителя Elastic Inference, указанного в определении задачи. Дополнительную информацию см. в разделе Работа с ускорителями Amazon Elastic Inference в Amazon ECS в Руководстве разработчика Amazon Elastic Container Service.

deviceName -> (строка)

Имя устройства ускорителя Elastic Inference для переопределения задачи. Этот параметр должен соответствовать deviceName, указанному в определении задачи.

deviceType -> (строка)

Тип ускорителя Elastic Inference для использования.

executionRoleArn -> (строка)

Amazon Resource Name (ARN) переопределения роли выполнения задачи для задачи. Дополнительную информацию см. в разделе IAM-роль выполнения задач Amazon ECS в Руководстве разработчика Amazon Elastic Container Service.

memory -> (строка)

Переопределение памяти для задачи.

taskRoleArn -> (строка)

Amazon Resource Name (ARN) роли, которую контейнеры в этой задаче могут принять. Все контейнеры в этой задаче получают разрешения, указанные в этой роли. Дополнительную информацию см. в разделе IAM-роль для задач в Руководстве разработчика Amazon Elastic Container Service.

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

Переопределение параметров временного хранилища для задачи.

Примечание

Этот параметр поддерживается только для задач, размещенных в Fargate, которые используют следующие версии платформы:

  • Версия платформы Linux 1.4.0 или более поздняя.
  • Версия платформы Windows 1.0.0 или более поздняя.

sizeInGiB -> (целое число)

Общий объем временного хранилища, задаваемый в Гигабайтах для задачи. Минимальное поддерживаемое значение — 21 ГБ, а максимальное — 200 ГБ.

Синтаксис JSON:

{
  "containerOverrides": [
    {
      "name": "string",
      "command": ["string", ...],
      "environment": [
        {
          "name": "string",
          "value": "string"
        }
        ...
      ],
      "environmentFiles": [
        {
          "value": "string",
          "type": "s3"
        }
        ...
      ],
      "cpu": integer,
      "memory": integer,
      "memoryReservation": integer,
      "resourceRequirements": [
        {
          "value": "string",
          "type": "GPU"|"InferenceAccelerator"
        }
        ...
      ]
    }
    ...
  ],
  "cpu": "string",
  "inferenceAcceleratorOverrides": [
    {
      "deviceName": "string",
      "deviceType": "string"
    }
    ...
  ],
  "executionRoleArn": "string",
  "memory": "string",
  "taskRoleArn": "string",
  "ephemeralStorage": {
    "sizeInGiB": integer
  }
}

--propagate-tags (строка)

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

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

  • TASK_DEFINITION
  • SERVICE
  • NONE

--reference-id (строка)

Этот параметр используется только Amazon ECS. Он не предназначен для использования клиентами.

--started-by (строка)

Необязательная метка, задаваемая при запуске задачи. Например, если вы автоматически запускаете задачу для выполнения задания пакетной обработки, вы можете применить уникальный идентификатор этого задания к вашей задаче с параметром startedBy. Затем вы можете идентифицировать задачи, относящиеся к этому заданию, отфильтровав результаты вызова ListTasks с значением startedBy. Разрешается до 36 букв (строчные и прописные), цифр, дефисов (-), косых черт (/), и подчеркиваний (_).

Если задача запущена сервисом Amazon ECS, параметр startedBy содержит идентификатор развертывания сервиса, который её запустил.

--tags (список)

Метаданные, которые вы применяете к задаче, чтобы помочь в их категоризации и организации. Каждая метка состоит из ключа и необязательного значения, которые вы определяете.

Применяются следующие основные ограничения к меткам:

  • Максимальное количество меток на ресурс - 50
  • Для каждого ресурса каждый ключ метки должен быть уникальным, и каждый ключ метки может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Юникода в UTF-8
  • Максимальная длина значения - 256 символов Юникода в UTF-8
  • Если ваша схема меток используется в нескольких службах и ресурсах, помните, что другие службы могут иметь ограничения на разрешённые символы. В целом разрешёнными символами являются: буквы, цифры и пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения меток чувствительны к регистру.
  • Не используйте aws: , AWS: или любую комбинацию таких префиксов в верхнем или нижнем регистре для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения меток с этим префиксом. Метки с этим префиксом не учитываются при подсчёте количества меток на ресурс.

(структура)

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

Применяются следующие основные ограничения к меткам:

  • Максимальное количество меток на ресурс - 50
  • Для каждого ресурса каждый ключ метки должен быть уникальным, и каждый ключ метки может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Юникода в UTF-8
  • Максимальная длина значения - 256 символов Юникода в UTF-8
  • Если ваша схема меток используется в нескольких службах и ресурсах, помните, что другие службы могут иметь ограничения на разрешённые символы. В целом разрешёнными символами являются: буквы, цифры и пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения меток чувствительны к регистру.
  • Не используйте aws: , AWS: или любую комбинацию таких префиксов в верхнем или нижнем регистре для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения меток с этим префиксом. Метки с этим префиксом не учитываются при подсчёте количества меток на ресурс.

key -> (строка)

Одна часть пары "ключ-значение", составляющей метку. key — это общая метка, которая действует как категория для более конкретных значений меток.

value -> (строка)

Необязательная часть пары "ключ-значение", составляющей метку. value действует как описание в категории метки (ключ).

Сокращенная запись:

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--task-definition (строка)

family и revision (family:revision ) или полный ARN определения задачи для запуска. Если revision не указан, используется последняя ACTIVE версия.

--volume-configurations (список)

Подробности тома, который был configuredAtLaunch. Вы можете настроить размер, тип тома, IOPS, пропускную способность, моментальный снимок и шифрование в TaskManagedEBSVolumeConfiguration. name тома должен соответствовать name из определения задачи.

(структура)

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

name -> (строка)

Имя тома. Это значение должно соответствовать имени тома из объекта Volume в определении задачи.

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

Настройка тома Amazon EBS, который Amazon ECS создаёт и управляет от вашего имени. Эти настройки используются для создания каждого тома Amazon EBS, при этом для каждой задачи создаётся один том. Тома Amazon EBS будут видны в вашей учётной записи в консоли Amazon EC2 после их создания.

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

Указывает, должен ли том быть зашифрован. Если вы включили шифрование Amazon EBS на уровне региона по умолчанию, но установили это значение как false, настройка переопределяется, и том шифруется с помощью ключа KMS, указанного для шифрования Amazon EBS по умолчанию. Этот параметр отображается в 1:1 с параметром Encrypted API CreateVolume в Справочнике по API Amazon EC2.

kmsKeyId -> (строка)

Идентификатор Amazon Resource Name (ARN) ключа службы управления ключами Amazon Web Services, который следует использовать для шифрования Amazon EBS. Когда ключ указывается с помощью этого параметра, он переопределяет шифрование Amazon EBS по умолчанию или любой ключ KMS, который вы указали для шифрования управляемого хранилища на уровне кластера. Этот параметр отображается в 1:1 с параметром KmsKeyId API CreateVolume в Справочнике по API Amazon EC2. Дополнительную информацию о шифровании томов Amazon EBS, подключённых к задаче, см. в разделе Зашифровать данные, хранящиеся в томах Amazon EBS, подключённых к задачам Amazon ECS.

Предупреждение

Amazon Web Services аутентифицирует ключ службы управления ключами Amazon Web Services асинхронно. Поэтому, если вы укажете недействительный идентификатор, псевдоним или ARN, действие может показаться завершённым, но в конечном итоге завершится ошибкой.

volumeType -> (строка)

Тип тома. Этот параметр отображается в 1:1 с параметром VolumeType API CreateVolume в Справочнике по API Amazon EC2. Дополнительную информацию см. в разделе Типы томов Amazon EBS в Руководстве пользователя Amazon EC2.

Поддерживаются следующие типы томов.

  • SSD общего назначения: gp2 |gp3
  • SSD с предоставленной IOPS: io1 |io2
  • HDD с оптимизированной пропускной способностью: st1
  • HDD для холодного хранения: sc1
  • Магнитный: standard

Примечание

Тип тома «Магнитный» не поддерживается в Fargate.

sizeInGiB -> (целое число)

Размер тома в ГБ. Вы должны указать либо размер тома, либо идентификатор моментального снимка. Если вы указываете идентификатор моментального снимка, размер моментального снимка по умолчанию используется для размера тома. Вы можете дополнительно указать размер тома, больше или равный размеру моментального снимка. Этот параметр отображается в 1:1 с параметром Size API CreateVolume в Справочнике по API Amazon EC2.

Поддерживаемые значения размера тома для каждого типа тома:

  • gp2 и gp3 : 1-16 384
  • io1 и io2 : 4-16 384
  • st1 и sc1 : 125-16 384
  • standard : 1-1024

snapshotId -> (строка)

Моментальный снимок, который Amazon ECS использует для создания тома. Вы должны указать либо идентификатор моментального снимка, либо размер тома. Этот параметр отображается в 1:1 с параметром SnapshotId API CreateVolume в Справочнике по API Amazon EC2.

volumeInitializationRate -> (целое число)

Скорость в МБ/с, с которой данные извлекаются из моментального снимка существующего тома Amazon EBS для создания нового тома для подключения к задаче. Этот параметр можно указать только если вы указали snapshotId. Дополнительную информацию см. в разделе Инициализация томов Amazon EBS в Руководстве пользователя Amazon EBS.

iops -> (целое число)

Количество операций ввода-вывода в секунду (IOPS). Для томов gp3, io1 и io2 это количество IOPS, предоставленных для тома. Для томов gp2 это базовая производительность тома и скорость, с которой том накапливает кредиты I/O для повышения производительности.

Поддерживаемые значения для каждого типа тома:

  • gp3 : 3 000–16 000 IOPS
  • io1 : 100–64 000 IOPS
  • io2 : 100–256 000 IOPS

Этот параметр необходим для томов io1 и io2. По умолчанию для томов gp3 установлено значение 3,000 IOPS. Этот параметр не поддерживается для томов st1, sc1 или standard.

Этот параметр отображается в 1:1 с параметром Iops API CreateVolume в Справочнике по API Amazon EC2.

throughput -> (целое число)

Пропускная способность для предоставления тома в МБ/с, с максимальным значением 1 000 МБ/с. Этот параметр отображается в 1:1 с параметром Throughput API CreateVolume в Справочнике по API Amazon EC2.

Предупреждение

Этот параметр поддерживается только для типа тома gp3.

tagSpecifications -> (список)

Теги, применяемые к тому. Amazon ECS по умолчанию применяет управляемые теги сервиса. Этот параметр отображается в 1:1 с параметром TagSpecifications.N API CreateVolume в Справочнике по API Amazon EC2.

(структура)

Характеристики тегов тома Amazon EBS.

resourceType -> (строка)

Тип ресурса тома.

tags -> (список)

Теги, применённые к этому тому Amazon EBS. AmazonECSCreated и AmazonECSManaged — это зарезервированные теги, которые нельзя использовать.

(структура)

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

Применяются следующие базовые ограничения к тегам:

  • Максимальное количество тегов на ресурс — 50
  • Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
  • Максимальная длина ключа — 128 символов Юникода в UTF-8
  • Максимальная длина значения — 256 символов Юникода в UTF-8
  • Если ваша схема тегов используется в нескольких службах и ресурсах, помните, что другие службы могут иметь ограничения на разрешённые символы. В общем, разрешены буквы, цифры и пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения тегов чувствительны к регистру.
  • Не используйте aws:, AWS: или любые комбинации верхнего и нижнего регистра таких, как префикс для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчёте тегов на ресурс.

key -> (строка)

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

value -> (строка)

Необязательная часть пары ключ-значение, составляющей тег. Значение действует как описание в категории тегов (ключ).

propagateTags -> (строка)

Определяет, следует ли распространять теги из определения задачи на том Amazon EBS. Теги могут распространяться только на SERVICE, указанный в ServiceVolumeConfiguration. Если значение не указано, теги не распространяются.

roleArn -> (строка)

ARN роли IAM, которую следует связать с этим томом. Это роль IAM инфраструктуры Amazon ECS, используемая для управления вашей инфраструктурой Amazon Web Services. Рекомендуется использовать управляемую Amazon ECS политику IAM AmazonECSInfrastructureRolePolicyForVolumes с этой ролью. Дополнительную информацию см. в разделе Роль IAM инфраструктуры Amazon ECS в Руководстве разработчика Amazon ECS.

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

Политика завершения для тома при завершении задачи. Это позволяет управлять тем, завершает ли Amazon ECS том Amazon EBS при остановке задачи.

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

Указывает, следует ли удалить том при завершении задачи. Если указано значение true, Amazon ECS удаляет том Amazon EBS от вашего имени, когда задача переходит в состояние STOPPED. Если значение не указано, используется значение по умолчанию true. При установке в значение false Amazon ECS оставляет том в вашей учётной записи.

filesystemType -> (строка)

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

Доступные типы файловых систем: ext3, ext4 и xfs. Если значение не указано, по умолчанию используется файловая система xfs.

Синтаксис JSON:

[
  {
    "name": "string",
    "managedEBSVolume": {
      "encrypted": true|false,
      "kmsKeyId": "string",
      "volumeType": "string",
      "sizeInGiB": integer,
      "snapshotId": "string",
      "volumeInitializationRate": integer,
      "iops": integer,
      "throughput": integer,
      "tagSpecifications": [
        {
          "resourceType": "volume",
          "tags": [
            {
              "key": "string",
              "value": "string"
            }
            ...
          ],
          "propagateTags": "TASK_DEFINITION"|"SERVICE"|"NONE"
        }
        ...
      ],
      "roleArn": "string",
      "terminationPolicy": {
        "deleteOnTermination": true|false
      },
      "filesystemType": "ext3"|"ext4"|"xfs"|"ntfs"
    }
  }
  ...
]

--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 (boolean)

Включить отладку регистрации.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

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

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификата CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить пагинатор CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Пример 1: Запуск новой задачи

Следующий start-task пример запускает задачу, используя последнюю ревизию sleep360 определения задачи, на указанном контейнерном экземпляре в кластере по умолчанию.

aws ecs start-task \
    --task-definition sleep360 \
    --container-instances 765936fadbdd46b5991a4bd70c2a43d4

Вывод:

{
    "tasks": [
        {
            "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/666fdccc2e2d4b6894dd422f4eeee8f8",
            "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default",
            "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:3",
            "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4",
            "overrides": {
                "containerOverrides": [
                    {
                        "name": "sleep"
                    }
                ]
            },
            "lastStatus": "PENDING",
            "desiredStatus": "RUNNING",
            "cpu": "128",
            "memory": "128",
            "containers": [
                {
                    "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/75f11ed4-8a3d-4f26-a33b-ad1db9e02d41",
                    "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/666fdccc2e2d4b6894dd422f4eeee8f8",
                    "name": "sleep",
                    "lastStatus": "PENDING",
                    "networkInterfaces": [],
                    "cpu": "10",
                    "memory": "10"
                }
            ],
            "version": 1,
            "createdAt": 1563421494.186,
            "group": "family:sleep360",
            "launchType": "EC2",
            "attachments": [],
            "tags": []
        }
    ],
    "failures": []
}

Дополнительную информацию см. в разделе Расписание контейнеров в Amazon ECS в Руководстве разработчика Amazon ECS.

Пример 2: Настройка тома Amazon EBS при запуске задачи

Следующий start-task пример настраивает зашифрованный том Amazon EBS для задачи на указанном контейнерном экземпляре. У вас должна быть настроена роль инфраструктуры Amazon ECS с прикрепленной управляемой политикой AmazonECSInfrastructureRolePolicyForVolumes. Вы должны указать определение задачи с тем же именем тома, что и в запросе start-task. В этом примере используется параметр --cli-input-json и файл ввода JSON под названием ebs.json со следующим содержимым.

aws ecs start-task \
    --cli-input-json file://ebs.json \
    --container-instances 765936fadbdd46b5991a4bd70c2a43d4

Содержимое ebs.json:

{
   "cluster": "default",
   "taskDefinition": "mytaskdef",
   "networkConfiguration":{
        "awsvpcConfiguration":{
            "assignPublicIp": "ENABLED",
            "securityGroups": ["sg-12344321"],
            "subnets":["subnet-12344321"]
        }
    },
   "volumeConfigurations": [
        {
            "name": "myEBSVolume",
            "managedEBSVolume": {
                "volumeType": "gp3",
                "sizeInGiB": 100,
                "roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole",
                "encrypted": true,
                "kmsKeyId": "arn:aws:kms:region:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab"
            }
        }
    ]
}

Вывод:

{
    "tasks": [
        {
            "attachments": [
                {
                    "id": "aea29489-9dcd-49f1-8164-4d91566e1113",
                    "type": "ElasticNetworkInterface",
                    "status": "PRECREATED",
                    "details": [
                        {
                            "name": "subnetId",
                            "value": "subnet-12344321"
                        }
                    ]
                },
                {
                    "id": "f29e1222-9a1e-410f-b499-a12a7cd6d42e",
                    "type": "AmazonElasticBlockStorage",
                    "status": "CREATED",
                    "details": [
                        {
                            "name": "roleArn",
                            "value": "arn:aws:iam::123456789012:role/ecsInfrastructureRole"
                        },
                        {
                            "name": "volumeName",
                            "value": "myEBSVolume"
                        },
                        {
                            "name": "deleteOnTermination",
                            "value": "true"
                        }
                    ]
                }
            ],
            "attributes": [
                {
                    "name": "ecs.cpu-architecture",
                    "value": "arm64"
                }
            ],
            "availabilityZone": "us-west-2c",
            "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default",
            "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4",
            "containers": [
                {
                    "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/default/bb122ace3ed84add92c00a351a03c69e/a4a9ed10-51c7-4567-9653-50e71b94f867",
                    "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/bb122ace3ed84add92c00a351a03c69e",
                    "name": "container-using-ebs",
                    "image": "amazonlinux:2",
                    "lastStatus": "PENDING",
                    "networkInterfaces": [],
                    "cpu": "0"
                }
            ],
            "cpu": "1024",
            "createdAt": "2025-01-23T14:51:05.191000-06:00",
            "desiredStatus": "RUNNING",
            "enableExecuteCommand": false,
            "group": "family:mytaskdef",
            "lastStatus": "PROVISIONING",
            "launchType": "EC2",
            "memory": "3072",
            "overrides": {
                "containerOverrides": [
                    {
                        "name": "container-using-ebs"
                    }
                ],
                "inferenceAcceleratorOverrides": []
            },
             "tags": [],
            "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/bb122ace3ed84add92c00a351a03c69e",
            "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:4",
            "version": 1
        }
    ],
    "failures": []
}

Дополнительную информацию см. в разделе Использование томов Amazon EBS с Amazon ECS в Руководстве разработчика Amazon ECS.

Вывод

tasks -> (список)

Полное описание запущенных задач. Описывается каждая задача, успешно размещенная на ваших экземплярах контейнеров.

(структура)

Подробности о задаче в кластере.

attachments -> (список)

Elastic Network Adapter, связанный с задачей, если задача использует режим сети awsvpc.

(структура)

Объект, представляющий экземпляр контейнера или вложение задачи.

id -> (строка)

Уникальный идентификатор вложения.

type -> (строка)

Тип вложения, такой как ElasticNetworkInterface, Service Connect и AmazonElasticBlockStorage.

status -> (строка)

Состояние вложения. Допустимые значения: PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, DELETED и FAILED.

details -> (список)

Подробности о вложении.

Для интерфейсов эластичной сети это включает идентификатор сетевого интерфейса, MAC-адрес, идентификатор подсети и частный IPv4-адрес.

Для служб Service Connect это включает portName, clientAliases, discoveryName и ingressPortOverride.

Для Elastic Block Storage это включает roleArn, deleteOnTermination, volumeName, volumeId и statusReason (только когда вложение не удалось создать или подключить).

(структура)

Объект пар «ключ-значение».

name -> (строка)

Имя пары «ключ-значение». Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары «ключ-значение». Для переменных среды это значение переменной среды.

attributes -> (список)

Атрибуты задачи

(структура)

Атрибут — это пара «имя-значение», связанная с объектом Amazon ECS. Используйте атрибуты для расширения модели данных Amazon ECS, добавляя пользовательские метаданные к вашим ресурсам. Дополнительная информация см. в разделе Атрибуты в руководстве разработчика Amazon Elastic Container Service.

name -> (строка)

Имя атрибута. name должно содержать от 1 до 128 символов. Имя может содержать буквы (строчные и прописные), цифры, дефисы (-), подчеркивания (_), слеши (/), обратные слеши (), или точки (.).

value -> (строка)

Значение атрибута. value должно содержать от 1 до 128 символов. Оно может содержать буквы (строчные и прописные), цифры, дефисы (-), подчеркивания (_), точки (.), знаки «@», слеши (/), обратные слеши (), двоеточия (:) или пробелы. Значение не может начинаться или заканчиваться пробелом.

targetType -> (строка)

Тип целевого объекта, к которому привязывается атрибут. Этот параметр обязателен, если вы используете сокращенную форму ID ресурса вместо полного ARN.

targetId -> (строка)

Идентификатор целевого объекта. Вы можете указать сокращенную форму ID ресурса или полный Amazon Resource Name (ARN).

availabilityZone -> (строка)

Аварийная зона для задачи.

capacityProviderName -> (строка)

Провайдер емкости, связанный с задачей.

clusterArn -> (строка)

ARN кластера, в котором размещена задача.

connectivity -> (строка)

Статус подключения задачи.

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

Unix-метка времени последнего перехода задачи в состояние CONNECTED.

containerInstanceArn -> (строка)

ARN экземпляров контейнеров, которые размещают задачу.

containers -> (список)

Контейнеры, связанные с задачей.

(структура)

Контейнер Docker, являющийся частью задачи.

containerArn -> (строка)

Amazon Resource Name (ARN) контейнера.

taskArn -> (строка)

ARN задачи.

name -> (строка)

Имя контейнера.

image -> (строка)

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

imageDigest -> (строка)

Хеш-сумма образа контейнера.

runtimeId -> (строка)

Идентификатор контейнера Docker.

lastStatus -> (строка)

Последнее известное состояние контейнера.

exitCode -> (целое число)

Код завершения, возвращенный контейнером.

reason -> (строка)

Короткое (максимум 1024 символа) читаемое человеком сообщение, предоставляющее дополнительные сведения о работающем или остановленном контейнере.

networkBindings -> (список)

Связанные с контейнером сетевые привязки.

(структура)

Подробности о сетевых привязках между контейнером и его хост-экземпляром контейнера. После того, как задача достигнет состояния RUNNING, ручные и автоматические назначения портов хоста и контейнера отображаются в разделе networkBindings ответов API DescribeTasks.

bindIP -> (строка)

IP-адрес, к которому привязан контейнер на экземпляре контейнера.

containerPort -> (целое число)

Номер порта в контейнере, используемый при сетевой привязке.

hostPort -> (целое число)

Номер порта на хосте, используемый при сетевой привязке.

protocol -> (строка)

Протокол, используемый для сетевой привязки.

containerPortRange -> (строка)

Диапазон номеров портов в контейнере, привязанный к динамически назначаемому диапазону портов хоста.

Следующие правила применяются при указании containerPortRange:

  • Вы должны использовать режим сети bridge или режим сети awsvpc.
  • Этот параметр доступен для типов запуска EC2 и Fargate.
  • Этот параметр доступен для операционных систем Linux и Windows.
  • Экземпляр контейнера должен иметь не менее версии 1.67.0 агента контейнера и не менее версии 1.67.0-1 пакета ecs-init
  • Вы можете указать не более 100 диапазонов портов на контейнер.
  • hostPortRange не указывается. Значение hostPortRange устанавливается следующим образом:
    • Для контейнеров в задаче с режимом сети awsvpc, hostPortRange устанавливается равным значению containerPortRange. Это стратегия статического сопоставления.
    • Для контейнеров в задаче с режимом сети bridge агент Amazon ECS находит свободные порты хоста из стандартного диапазона временных портов и передает их docker для привязки к портам контейнера.
  • Допустимые значения containerPortRange находятся в диапазоне от 1 до 65535.
  • Порт может быть включен только в одну привязку портов на контейнер.
  • Нельзя указывать перекрывающиеся диапазоны портов.
  • Первый порт в диапазоне должен быть меньше последнего порта в диапазоне.
  • Docker рекомендует отключить docker-proxy в файле конфигурации демона Docker, когда у вас большое количество портов. Дополнительную информацию см. в проблеме #11185 на сайте Github. Сведения о том, как отключить docker-proxy в файле конфигурации демона Docker, см. в разделе Демон Docker в руководстве разработчика Amazon ECS.

Вы можете вызвать ` DescribeTasks https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html`__ чтобы просмотреть hostPortRange, которые являются портами хоста, привязанными к портам контейнера.

hostPortRange -> (строка)

Диапазон номеров портов хоста, используемый при сетевой привязке. Он назначается docker и передается агентом Amazon ECS.

networkInterfaces -> (список)

Сетевые интерфейсы, связанные с контейнером.

(структура)

Объект, представляющий эластичный сетевой интерфейс для задач, использующих режим сети awsvpc.

attachmentId -> (строка)

Идентификатор вложения сетевого интерфейса.

privateIpv4Address -> (строка)

Частный IPv4-адрес сетевого интерфейса.

ipv6Address -> (строка)

Частный IPv6-адрес сетевого интерфейса.

healthStatus -> (строка)

Статус работоспособности контейнера. Если для этого контейнера в его определении задачи не настроены проверки работоспособности, он сообщает о статусе работоспособности как UNKNOWN.

managedAgents -> (список)

Подробности любых управляемых агентов Amazon ECS, связанных с контейнером.

(структура)

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

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

Unix-метка времени последнего запуска управляемого агента.

name -> (строка)

Имя управляемого агента. При включенном функционале команды execute имя управляемого агента — ExecuteCommandAgent.

reason -> (строка)

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

lastStatus -> (строка)

Последнее известное состояние управляемого агента.

cpu -> (строка)

Количество единиц ЦП, заданных для контейнера. Значение — 0, если в определении контейнера при регистрации определения задачи не было указано значение.

memory -> (строка)

Жесткий лимит (в МБ) памяти, заданный для контейнера.

memoryReservation -> (строка)

Мягкий лимит (в МБ) памяти, заданный для контейнера.

gpuIds -> (список)

Идентификаторы каждого GPU, назначенного контейнеру.

(строка)

cpu -> (строка)

Количество единиц ЦП, используемых задачей, выраженное в определении задачи. Оно может быть выражено как целое число, используя единицы ЦП (например, 1024). Также его можно выразить как строку, используя vCPU (например, 1 vCPU или 1 vcpu). Строковые значения преобразуются в целое число, указывающее единицы ЦП при регистрации определения задачи.

При использовании типов запуска EC2 или внешнего типа запуска этот параметр является необязательным. Поддерживаемые значения находятся в диапазоне от 128 единиц ЦП (0.125 vCPU) до 196608 единиц ЦП (192 vCPU). Если вы не укажете значение, параметр будет проигнорирован.

Этот параметр обязателен для Fargate. Сведения о допустимых значениях см. в разделе Размер задачи в руководстве разработчика Amazon Elastic Container Service.

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

Unix-метка времени создания задачи. Точнее, это время, когда задача перешла в состояние PENDING.

desiredStatus -> (строка)

Желаемое состояние задачи. Дополнительная информация см. в разделе Жизненный цикл задачи.

enableExecuteCommand -> (булево)

Определяет, включена ли возможность выполнения команды execute для этой задачи. Если true, функционал выполнения команд execute включен для всех контейнеров в задаче.

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

Unix-метка времени остановки выполнения задачи.

group -> (строка)

Имя группы задач, связанной с задачей.

healthStatus -> (строка)

Статус работоспособности задачи. Определяется состоянием основных контейнеров в задаче. Если все основные контейнеры в задаче сообщают о статусе HEALTHY , то статус задачи также отображается как HEALTHY . Если какие-либо основные контейнеры в задаче сообщают о статусе UNHEALTHY или UNKNOWN , то статус задачи также отображается как UNHEALTHY или UNKNOWN .

Примечание

Агент контейнеров Amazon ECS не отслеживает и не сообщает о проверках работоспособности Docker, встроенных в образ контейнера и не указанных в определении контейнера. Например, это относится к тем, которые указаны в родительском образе или в Dockerfile образа. Параметры проверки работоспособности, указанные в определении контейнера, переопределяют любые проверки работоспособности Docker, обнаруженные в образе контейнера.

inferenceAccelerators -> (список)

Ускоритель Elastic Inference, связанный с задачей.

(структура)

Подробная информация об ускорителе Elastic Inference. Дополнительную информацию см. в разделе Работа с Amazon Elastic Inference в Amazon ECS в Руководстве разработчика Amazon Elastic Container Service .

deviceName -> (строка)

Имя устройства ускорителя Elastic Inference. deviceName также должен быть указан в определении контейнера как ResourceRequirement.

deviceType -> (строка)

Тип ускорителя Elastic Inference, который нужно использовать.

lastStatus -> (строка)

Последний известный статус задачи. Дополнительную информацию см. в разделе Жизненный цикл задач .

launchType -> (строка)

Инфраструктура, на которой выполняется ваша задача. Дополнительную информацию см. в разделе Типы запуска Amazon ECS в Руководстве разработчика Amazon Elastic Container Service .

memory -> (строка)

Объем памяти (в МБ), используемый задачей, выраженный в определении задачи. Он может быть выражен как целое число, используя МБ (например, 1024 ). Если он выражен как строка, используя ГБ (например, 1GB или 1 GB ), он преобразуется в целое число, указывающее МБ при регистрации определения задачи.

Если используется тип запуска EC2, это поле необязательно.

Если используется тип запуска Fargate, это поле обязательно. Вы должны использовать одно из следующих значений. Выбранное значение определяет диапазон поддерживаемых значений для параметра cpu.

  • 512 (0,5 ГБ), 1024 (1 ГБ), 2048 (2 ГБ) - Доступные cpu значения: 256 (.25 vCPU)
  • 1024 (1 ГБ), 2048 (2 ГБ), 3072 (3 ГБ), 4096 (4 ГБ) - Доступные cpu значения: 512 (.5 vCPU)
  • 2048 (2 ГБ), 3072 (3 ГБ), 4096 (4 ГБ), 5120 (5 ГБ), 6144 (6 ГБ), 7168 (7 ГБ), 8192 (8 ГБ) - Доступные cpu значения: 1024 (1 vCPU)
  • Между 4096 (4 ГБ) и 16384 (16 ГБ) с шагом 1024 (1 ГБ) - Доступные cpu значения: 2048 (2 vCPU)
  • Между 8192 (8 ГБ) и 30720 (30 ГБ) с шагом 1024 (1 ГБ) - Доступные cpu значения: 4096 (4 vCPU)
  • Между 16 ГБ и 60 ГБ с шагом 4 ГБ - Доступные cpu значения: 8192 (8 vCPU) Этот вариант требует платформу Linux 1.4.0 или более позднюю.
  • Между 32 ГБ и 120 ГБ с шагом 8 ГБ - Доступные cpu значения: 16384 (16 vCPU) Этот вариант требует платформу Linux 1.4.0 или более позднюю.

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

Один или несколько переопределений контейнера.

containerOverrides -> (список)

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

(структура)

Переопределения, отправляемые в контейнер. Можно передать пустое переопределение контейнера. Пример пустого переопределения контейнера - {"containerOverrides": [ ] } . Если указано непустое переопределение контейнера, необходимо указать параметр name.

Для хранения конфиденциальных данных можно использовать Secrets Manager или Amazon Web Services Systems Manager Parameter Store. Дополнительную информацию см. в разделе Получение секретов через переменные среды в Руководстве разработчика Amazon ECS.

name -> (строка)

Имя контейнера, который получает переопределение. Этот параметр требуется, если указано какое-либо переопределение.

command -> (список)

Команда, отправляемая в контейнер, которая переопределяет команду по умолчанию из образа Docker или определения задачи. Также необходимо указать имя контейнера.

(строка)

environment -> (список)

Переменные среды, отправляемые в контейнер. Можно добавлять новые переменные среды, которые добавляются в контейнер при запуске, или переопределять существующие переменные среды из образа Docker или определения задачи. Также необходимо указать имя контейнера.

(структура)

Объект пары ключ-значение.

name -> (строка)

Имя пары ключ-значение. Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары ключ-значение. Для переменных среды это значение переменной среды.

environmentFiles -> (список)

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

(структура)

Список файлов, содержащих переменные среды, которые нужно передать контейнеру. Можно указать до десяти файлов среды. Файл должен иметь расширение .env . Каждая строка в файле среды должна содержать переменную среды в формате VARIABLE=VALUE. Строки, начинающиеся с #, рассматриваются как комментарии и игнорируются.

Если переменные среды указаны с помощью параметра environment в определении контейнера, они имеют приоритет над переменными, содержащимися в файле среды. Если несколько файлов среды содержат одну и ту же переменную, они обрабатываются сверху вниз. Рекомендуется использовать уникальные имена переменных. Дополнительную информацию см. в разделе Использование файла для передачи переменных среды в контейнер в Руководстве разработчика Amazon Elastic Container Service .

Файлы переменных среды — это объекты в Amazon S3, и применяются все соображения безопасности Amazon S3.

Для типа запуска Fargate необходимо использовать следующие платформы:

  • Платформа Linux версии 1.4.0 или более поздней.
  • Платформа Windows версии 1.0.0 или более поздней.

Учитывайте следующее при использовании типа запуска Fargate:

  • Файл обрабатывается как собственный файл Docker env.
  • Обработка экранирования оболочки не поддерживается.
  • Точка входа контейнера интерпретирует значения VARIABLE.

value -> (строка)

Amazon Resource Name (ARN) объекта Amazon S3, содержащего файл переменной среды.

type -> (строка)

Тип файла, который нужно использовать. Файлы среды — это объекты в Amazon S3. Поддерживается только значение s3 .

cpu -> (целое число)

Количество cpu единиц, зарезервированных для контейнера, вместо значения по умолчанию из определения задачи. Также необходимо указать имя контейнера.

memory -> (целое число)

Жесткий лимит памяти (в МБ), предоставляемый контейнеру, вместо значения по умолчанию из определения задачи. Если контейнер пытается превысить указанный здесь лимит памяти, контейнер завершается. Также необходимо указать имя контейнера.

memoryReservation -> (целое число)

Мягкий лимит памяти (в МБ), которую нужно зарезервировать для контейнера, вместо значения по умолчанию из определения задачи. Также необходимо указать имя контейнера.

resourceRequirements -> (список)

Тип и объем ресурса, которые нужно назначить контейнеру, вместо значения по умолчанию из определения задачи. Поддерживается только ресурс GPU.

(структура)

Тип и объем ресурса, которые нужно назначить контейнеру. Поддерживаемые типы ресурсов — GPU и ускорители Elastic Inference. Дополнительную информацию см. в разделах Работа с GPU в Amazon ECS или Работа с Amazon Elastic Inference в Amazon ECS в Руководстве разработчика Amazon Elastic Container Service

value -> (строка)

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

Когда тип — GPU, значение — количество физических GPUs, которое агент контейнеров Amazon ECS резервирует для контейнера. Количество GPU, зарезервированных для всех контейнеров в задаче, не может превышать количество доступных GPU на экземпляре контейнера, на котором запускается задача.

Когда тип — InferenceAccelerator, value соответствует deviceName для InferenceAccelerator, указанного в определении задачи.

type -> (строка)

Тип ресурса, который нужно назначить контейнеру.

cpu -> (строка)

Переопределение CPU для задачи.

inferenceAcceleratorOverrides -> (список)

Переопределение ускорителя Elastic Inference для задачи.

(структура)

Подробная информация о переопределении задачи с ускорителем Elastic Inference. Этот параметр используется для переопределения ускорителя Elastic Inference, указанного в определении задачи. Дополнительную информацию см. в разделе Работа с Amazon Elastic Inference в Amazon ECS в Руководстве разработчика Amazon Elastic Container Service .

deviceName -> (строка)

Имя устройства ускорителя Elastic Inference, которое нужно переопределить для задачи. Этот параметр должен совпадать с deviceName, указанным в определении задачи.

deviceType -> (строка)

Тип ускорителя Elastic Inference, который нужно использовать.

executionRoleArn -> (строка)

Amazon Resource Name (ARN) переопределения роли выполнения задачи для задачи. Дополнительную информацию см. в разделе Роль IAM для выполнения задач Amazon ECS в Руководстве разработчика Amazon Elastic Container Service .

memory -> (строка)

Переопределение памяти для задачи.

taskRoleArn -> (строка)

Amazon Resource Name (ARN) роли, которую контейнеры в этой задаче могут принять. Все контейнеры в этой задаче получают разрешения, указанные в этой роли. Дополнительную информацию см. в разделе Роль IAM для задач в Руководстве разработчика Amazon Elastic Container Service .

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

Переопределение параметров временного хранилища для задачи.

Примечание

Этот параметр поддерживается только для задач, размещенных на Fargate, которые используют следующие версии платформы:

  • Платформа Linux версии 1.4.0 или более поздней.
  • Платформа Windows версии 1.0.0 или более поздней.

sizeInGiB -> (целое число)

Общий объем временного хранилища в ГБ для задачи. Минимальное поддерживаемое значение — 21 ГБ, а максимальное — 200 ГБ.

platformVersion -> (строка)

Версия платформы, на которой выполняется ваша задача. Версия платформы указывается только для задач, использующих тип запуска Fargate. Если вы не указали её, используется версия платформы LATEST. Дополнительную информацию см. в разделе «Версии платформы Fargate» в руководстве разработчика Amazon Elastic Container Service.

platformFamily -> (string)

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

Все задачи, выполняемые в рамках данной службы, должны использовать то же самое значение platformFamily, что и служба (например, LINUX.).

pullStartedAt -> (timestamp)

Маркер времени Unix для момента начала извлечения образа контейнера.

pullStoppedAt -> (timestamp)

Маркер времени Unix для момента завершения извлечения образа контейнера.

startedAt -> (timestamp)

Маркер времени Unix для момента запуска задачи. Более точно, это момент перехода задачи из состояния PENDING в состояние RUNNING.

startedBy -> (string)

Тег, указанный при запуске задачи. Если задачу запустила служба Amazon ECS, параметр startedBy содержит идентификатор развертывания этой службы.

stopCode -> (string)

Код остановки, указывающий причину остановки задачи. stoppedReason может содержать дополнительные сведения.

Дополнительную информацию о кодах остановки см. в разделе «Коды ошибок остановленных задач» в руководстве разработчика Amazon ECS.

stoppedAt -> (timestamp)

Маркер времени Unix для момента остановки задачи. Более точно, это момент перехода задачи из состояния RUNNING в состояние STOPPED.

stoppedReason -> (string)

Причина остановки задачи.

stoppingAt -> (timestamp)

Маркер времени Unix для момента остановки задачи. Более точно, это момент перехода задачи из состояния RUNNING в состояние STOPPING.

tags -> (list)

Метаданные, которые вы применяете к задаче для облегчения категоризации и организации. Каждый тег состоит из ключа и необязательного значения. И ключ, и значение определяются вами.

Применяются следующие основные ограничения к тегам:

  • Максимальное количество тегов на ресурс - 50
  • Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Юникода в UTF-8
  • Максимальная длина значения - 256 символов Юникода в UTF-8
  • Если ваша схема тегов используется в нескольких службах и ресурсах, имейте в виду, что другие службы могут иметь ограничения на разрешенные символы. В общем случае разрешены буквы, цифры и пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения тегов чувствительны к регистру.
  • Не используйте aws:, AWS: или любую комбинацию верхнего и нижнего регистра этих значений в качестве префикса для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете лимита тегов на ресурс.

(structure)

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

Применяются следующие основные ограничения к тегам:

  • Максимальное количество тегов на ресурс - 50
  • Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
  • Максимальная длина ключа - 128 символов Юникода в UTF-8
  • Максимальная длина значения - 256 символов Юникода в UTF-8
  • Если ваша схема тегов используется в нескольких службах и ресурсах, имейте в виду, что другие службы могут иметь ограничения на разрешенные символы. В общем случае разрешены буквы, цифры и пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
  • Ключи и значения тегов чувствительны к регистру.
  • Не используйте aws:, AWS: или любую комбинацию верхнего и нижнего регистра этих значений в качестве префикса для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете лимита тегов на ресурс.

key -> (string)

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

value -> (string)

Необязательная часть пары ключ-значение, составляющей тег. Значение действует как описание в рамках категории тегов (ключ).

taskArn -> (string)

Amazon Resource Name (ARN) задачи.

taskDefinitionArn -> (string)

ARN определения задачи, которое создает задачу.

version -> (long)

Счетчик версии задачи. Каждый раз, когда задача претерпевает изменения, которые запускают событие CloudWatch, счетчик версии увеличивается. Если вы дублируете состояние задачи Amazon ECS с помощью CloudWatch Events, вы можете сравнить версию задачи, сообщенную действиями API Amazon ECS, с версией, сообщенной в CloudWatch Events для задачи (внутри объекта detail), чтобы убедиться, что версия в потоке событий актуальна.

ephemeralStorage -> (structure)

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

sizeInGiB -> (integer)

Общий объем временного хранилища в GiB для задачи. Минимальное поддерживаемое значение - 21 GiB, а максимальное - 200 GiB.

fargateEphemeralStorage -> (structure)

Настройки временного хранилища Fargate для задачи.

sizeInGiB -> (integer)

Общий объем временного хранилища в GiB для задачи. Минимальное поддерживаемое значение - 20 GiB, а максимальное - 200 GiB.

kmsKeyId -> (string)

Укажите идентификатор ключа управления ключами (Key Management Service) для шифрования временного хранилища задачи.

failures -> (list)

Любые ошибки, связанные с вызовом.

(structure)

Неудачный ресурс. Список распространенных причин см. в разделе «Причины ошибок API» в руководстве разработчика Amazon Elastic Container Service.

arn -> (string)

Amazon Resource Name (ARN) неудачного ресурса.

reason -> (string)

Причина ошибки.

detail -> (string)

Подробности ошибки.

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

Spec-Zone.ru

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