Spec-Zone.ru › AWS CLI v2

[ aws . snowball ]

обновить-задание

Описание

Пока значение задания JobState равно New, вы можете обновить некоторые сведения, связанные с заданием. После того, как задание перейдет в другое состояние, обычно в течение 60 минут с момента создания задания, этот действие больше недоступно.

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

Синтаксис

  update-job
--job-id <value>
[--role-arn <value>]
[--notification <value>]
[--resources <value>]
[--on-device-service-configuration <value>]
[--address-id <value>]
[--shipping-option <value>]
[--description <value>]
[--snowball-capacity-preference <value>]
[--forwarding-address-id <value>]
[--pickup-details <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]

Параметры

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

Идентификатор задания, которое вы хотите обновить, например, JID123e4567-e89b-12d3-a456-426655440000 .

--role-arn (строка)

Новый Amazon Resource Name (ARN) роли, которую вы хотите ассоциировать с этим заданием. Для создания ARN роли используйте действие CreateRole API-интерфейса Identity and Access Management (IAM).

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

Новый или обновленный объект Notification.

SnsTopicARN -> (строка)

Новый SNS TopicArn, который вы хотите ассоциировать с этим заданием. Вы можете создавать Amazon Resource Names (ARN) для тем, используя действие CreateTopic API-интерфейса Amazon SNS.

Вы можете подписывать адреса электронной почты на тему Amazon SNS через Amazon Web Services Management Console или с помощью действия Subscribe API-интерфейса Amazon Simple Notification Service (Amazon SNS).

JobStatesToNotify -> (список)

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

(строка)

NotifyAll -> (булево)

Любое изменение состояния задания будет вызывать уведомление для этого задания.

DevicePickupSnsTopicARN -> (строка)

Используется для отправки уведомлений SNS лицу, забирающему устройство (определено при создании задания).

Краткая синтаксическая запись:

SnsTopicARN=string,JobStatesToNotify=string,string,NotifyAll=boolean,DevicePickupSnsTopicARN=string

Синтаксис JSON:

{
  "SnsTopicARN": "string",
  "JobStatesToNotify": ["New"|"PreparingAppliance"|"PreparingShipment"|"InTransitToCustomer"|"WithCustomer"|"InTransitToAWS"|"WithAWSSortingFacility"|"WithAWS"|"InProgress"|"Complete"|"Cancelled"|"Listing"|"Pending", ...],
  "NotifyAll": true|false,
  "DevicePickupSnsTopicARN": "string"
}

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

Обновленный объект JobResource или обновленный объект JobResource.

S3Resources -> (список)

Массив объектов S3Resource.

(структура)

Каждый объект S3Resource представляет собой бакет Amazon S3, из которого или в который будет экспортироваться или импортироваться передаваемые данные. Для заданий экспорта этот объект может иметь необязательное значение KeyRange. Длина диапазона определяется при создании задания и имеет либо включительный BeginMarker, либо включительный EndMarker, либо оба. Диапазоны отсортированы в бинарном порядке UTF-8.

BucketArn -> (строка)

Amazon Resource Name (ARN) бакета Amazon S3.

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

Для заданий экспорта вы можете указать необязательный KeyRange в определенном бакете Amazon S3. Длина диапазона определяется при создании задания и имеет либо включительный BeginMarker, либо включительный EndMarker, либо оба. Диапазоны отсортированы в бинарном порядке UTF-8.

BeginMarker -> (строка)

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

EndMarker -> (строка)

Ключ, который завершает необязательный диапазон ключей для задания экспорта. Диапазоны включительные и отсортированы в бинарном порядке UTF-8.

TargetOnDeviceServices -> (список)

Указывает службу или службы на устройстве семейства Snow, из которых или в которые будут экспортироваться или импортироваться передаваемые данные. Amazon Web Services Snow Family поддерживает Amazon S3 и NFS (Network File System).

(структура)

Объект, представляющий службу или службы на устройстве семейства Snow, из которых или в которые будут экспортироваться или импортироваться передаваемые данные. Amazon Web Services Snow Family поддерживает Amazon S3 и NFS (Network File System).

ServiceName -> (строка)

Указывает имя службы на устройстве семейства Snow, из которой или в которую будут экспортироваться или импортироваться передаваемые данные.

TransferOption -> (строка)

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

LambdaResources -> (список)

Функции Lambda на языке Python для этого задания.

(структура)

Идентифицирует

LambdaArn -> (строка)

Amazon Resource Name (ARN), представляющий функцию Lambda, которая должна вызываться действиями PUT object в связанном локальном ресурсе Amazon S3.

EventTriggers -> (список)

Массив ARNs для объектов S3Resource, которые запускают объекты LambdaResource, связанные с этим заданием.

(структура)

Контейнер для EventTriggerDefinition$EventResourceARN .

EventResourceARN -> (строка)

Amazon Resource Name (ARN) любого локального ресурса Amazon S3, который является триггером события функции Lambda, связанной с этим заданием.

Ec2AmiResources -> (список)

Ассоциированные с этим заданием Amazon Machine Images (AMIs).

(структура)

Объект в формате JSON, содержащий идентификаторы Amazon Machine Image (AMI), включая идентификатор AMI, совместимый с Amazon EC2, и идентификатор AMI устройства Snow. У каждой AMI есть эти два идентификатора, чтобы упростить идентификацию AMI как в облаке Amazon Web Services, так и на устройстве.

AmiId -> (строка)

Идентификатор AMI в Amazon EC2.

SnowballAmiId -> (строка)

Идентификатор AMI на устройстве Snow.

Синтаксис JSON:

{
  "S3Resources": [
    {
      "BucketArn": "string",
      "KeyRange": {
        "BeginMarker": "string",
        "EndMarker": "string"
      },
      "TargetOnDeviceServices": [
        {
          "ServiceName": "NFS_ON_DEVICE_SERVICE"|"S3_ON_DEVICE_SERVICE",
          "TransferOption": "IMPORT"|"EXPORT"|"LOCAL_USE"
        }
        ...
      ]
    }
    ...
  ],
  "LambdaResources": [
    {
      "LambdaArn": "string",
      "EventTriggers": [
        {
          "EventResourceARN": "string"
        }
        ...
      ]
    }
    ...
  ],
  "Ec2AmiResources": [
    {
      "AmiId": "string",
      "SnowballAmiId": "string"
    }
    ...
  ]
}

--on-device-service-configuration (структура)

Указывает службу или службы на устройстве семейства Snow, из которых или в которые будут экспортироваться или импортироваться передаваемые данные. Amazon Web Services Snow Family поддерживает Amazon S3 и NFS (Network File System), а также службу Amazon Web Services Storage Gateway типа Tape Gateway.

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

Представляет службу NFS (Network File System) на устройстве семейства Snow.

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

Максимальный объем хранилища NFS для одного устройства семейства Snow.

StorageUnit -> (строка)

Единица измерения масштаба хранилища NFS на устройстве.

Допустимые значения: TB.

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

Представляет службу Storage Gateway типа Tape Gateway на устройстве семейства Snow.

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

Максимальное количество виртуальных лент для хранения на одном устройстве семейства Snow. Из-за ограничений физических ресурсов это значение должно быть установлено в 80 для Snowball Edge.

StorageUnit -> (строка)

Единица измерения масштаба виртуальных лент на устройстве.

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

Конфигурация EKS Anywhere на устройстве семейства Snow.

KubernetesVersion -> (строка)

Версия Kubernetes для EKS Anywhere на устройстве семейства Snow.

EKSAnywhereVersion -> (строка)

Необязательная версия EKS Anywhere на устройстве семейства Snow.

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

Настройка совместимого с Amazon S3 хранилища на устройствах семейства Snow.

StorageLimit -> (двойное число)

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

StorageUnit -> (строка)

Единица хранения. В настоящее время поддерживается только единица TB.

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

Применимо при создании кластера. Указывает количество узлов, необходимых для совместимого с Amazon S3 хранилища на устройствах семейства Snow. Если указано, другие входные данные можно опустить.

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

>Уровень отказоустойчивости кластера. Это указывает на количество узлов, которые могут выйти из строя, не ухудшая производительности кластера. Эти дополнительные входные данные полезны, когда указанное StorageLimit соответствует более чем одной конфигурации службы совместимого с Amazon S3 хранилища на устройствах семейства Snow.

Краткая синтаксическая запись:

NFSOnDeviceService={StorageLimit=integer,StorageUnit=string},TGWOnDeviceService={StorageLimit=integer,StorageUnit=string},EKSOnDeviceService={KubernetesVersion=string,EKSAnywhereVersion=string},S3OnDeviceService={StorageLimit=double,StorageUnit=string,ServiceSize=integer,FaultTolerance=integer}

Синтаксис JSON:

{
  "NFSOnDeviceService": {
    "StorageLimit": integer,
    "StorageUnit": "TB"
  },
  "TGWOnDeviceService": {
    "StorageLimit": integer,
    "StorageUnit": "TB"
  },
  "EKSOnDeviceService": {
    "KubernetesVersion": "string",
    "EKSAnywhereVersion": "string"
  },
  "S3OnDeviceService": {
    "StorageLimit": double,
    "StorageUnit": "TB",
    "ServiceSize": integer,
    "FaultTolerance": integer
  }
}

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

Идентификатор обновленного объекта Address.

--shipping-option (строка)

Обновленное значение варианта доставки для объекта ShippingDetails этого задания.

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

  • SECOND_DAY
  • NEXT_DAY
  • EXPRESS
  • STANDARD

--description (строка)

Обновленное описание объекта JobMetadata этого задания.

--snowball-capacity-preference (строка)

Обновленное значение SnowballCapacityPreference объекта JobMetadata этого задания. Snowball объемом 50 ТБ доступны только в регионах США.

Дополнительную информацию см. в разделе «https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html» (Типы устройств семейства Snow и емкость) в Руководстве пользователя Snowcone или в разделе «https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html» (Типы устройств семейства Snow и емкость) в Руководстве пользователя Snowcone.

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

  • T50
  • T80
  • T100
  • T42
  • T98
  • T8
  • T14
  • T32
  • NoPreference
  • T240
  • T13

--forwarding-address-id (строка)

Обновленный идентификатор адреса переадресации для задания. Это поле не поддерживается в большинстве регионов.

--pickup-details (структура)

Информация, идентифицирующая лицо, забирающее устройство.

Name -> (строка)

Имя лица, забирающего устройство.

PhoneNumber -> (строка)

Номер телефона лица, забирающего устройство.

Email -> (строка)

Адрес электронной почты лица, забирающего устройство.

IdentificationNumber -> (строка)

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

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

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

IdentificationIssuingOrg -> (строка)

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

DevicePickupId -> (строка)

Уникальный идентификатор устройства, которое будет забрано.

Краткая синтаксическая запись:

Name=string,PhoneNumber=string,Email=string,IdentificationNumber=string,IdentificationExpirationDate=timestamp,IdentificationIssuingOrg=string,DevicePickupId=string

Синтаксис JSON:

{
  "Name": "string",
  "PhoneNumber": "string",
  "Email": "string",
  "IdentificationNumber": "string",
  "IdentificationExpirationDate": timestamp,
  "IdentificationIssuingOrg": "string",
  "DevicePickupId": "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
  • текст
  • таблица
  • 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 для вывода.

--cli-auto-prompt (логическое)

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

--no-cli-auto-prompt (логическое)

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

Вывод

Нет

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

Spec-Zone.ru

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