describe-job
Описание
Возвращает информацию о конкретной задаче, включая информацию о доставке, статус задачи и другую важную метаданные.
См. также: Документация API AWS
Синтаксис
describe-job
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--job-id (строка)
JID123e4567-e89b-12d3-a456-426655440000 .--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью JSON-значения, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если указано значение output, он проверяет входные данные команды и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включить отладку регистрации.
--endpoint-url (строка)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.
--no-paginate (логическое значение)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из вашего файла учетных данных.
--region (строка)
Регион для использования. Переопределяет параметры конфигурации/среды.
--version (строка)
Показать версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификата CA для проверки сертификатов SSL. Переопределяет параметры конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного параметра cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
JobMetadata -> (структура)
Информация о конкретной задаче, включая информацию о доставке, статус задачи и другие важные метаданные.
JobId -> (строка)
JID123e4567-e89b-12d3-a456-426655440000 .JobState -> (строка)
JobType -> (строка)
SnowballType -> (строка)
CreationDate -> (временная метка)
Resources -> (структура)
Массив объектов S3Resource. Каждый объект S3Resource представляет собой хранилище Amazon S3, из которого или в которое будет экспортироваться передаваемые данные.
S3Resources -> (список)
Массив объектов S3Resource.
(структура)
Каждый объект S3Resource представляет собой хранилище Amazon S3, из которого или в которое будет экспортироваться передаваемые данные. Для задач экспорта этот объект может иметь необязательное значение KeyRange. Длина диапазона определяется при создании задачи и имеет либо включительный BeginMarker, либо включительный EndMarker, или оба. Диапазоны отсортированы в двоичном порядке UTF-8.
BucketArn -> (строка)
KeyRange -> (структура)
Для задач экспорта вы можете указать необязательный KeyRange в конкретном хранилище Amazon S3. Длина диапазона определяется при создании задачи и имеет либо включительный BeginMarker, либо включительный EndMarker, или оба. Диапазоны отсортированы в двоичном порядке UTF-8.
BeginMarker -> (строка)
EndMarker -> (строка)
TargetOnDeviceServices -> (список)
Указывает службу или службы на устройстве Snow Family, из которой или в которую будет экспортироваться или импортироваться передаваемые данные. Amazon Web Services Snow Family поддерживает Amazon S3 и NFS (Network File System).
(структура)
Объект, представляющий службу или службы на устройстве Snow Family, из которой или в которую будет экспортироваться или импортироваться передаваемые данные. Amazon Web Services Snow Family поддерживает Amazon S3 и NFS (Network File System).
ServiceName -> (строка)
TransferOption -> (строка)
LambdaResources -> (список)
Функции Lambda на языке Python для этой задачи.
(структура)
Идентифицирует
LambdaArn -> (строка)
EventTriggers -> (список)
Массив ARNs объектов S3Resource для запуска объектов LambdaResource, связанных с этой задачей.
(структура)
Контейнер для EventTriggerDefinition$EventResourceARN .
EventResourceARN -> (строка)
Ec2AmiResources -> (список)
Связанные с этой задачей Amazon Machine Images (AMI).
(структура)
Объект в формате JSON, содержащий идентификаторы Amazon Machine Image (AMI), включая идентификатор совместимого с Amazon EC2 AMI и идентификатор AMI устройства Snow. Каждая AMI имеет эти два идентификатора для упрощения идентификации AMI как в облаке Amazon Web Services, так и на устройстве.
AmiId -> (строка)
SnowballAmiId -> (строка)
Description -> (строка)
KmsKeyARN -> (строка)
RoleARN -> (строка)
AddressId -> (строка)
ShippingDetails -> (структура)
Информация о доставке задачи, включая номера отслеживания приёмки и отправки, а также варианты скорости доставки.
ShippingOption -> (строка)
Скорость доставки для конкретной задачи. Эта скорость не определяет, как скоро вы получите устройство Snow с момента создания задачи. Эта скорость представляет собой скорость перемещения к месту назначения во время транспортировки. Скорости доставки по регионам следующие:
- В Австралии доступна экспресс-доставка. Как правило, устройства Snow, отправленные экспресс-доставкой, доставляются примерно в течение одного дня.
- В Европейском союзе (ЕС) доступна экспресс-доставка. Как правило, устройства Snow, отправленные экспресс-доставкой, доставляются примерно в течение одного дня. Кроме того, большинство стран ЕС имеют доступ к стандартной доставке, которая обычно занимает менее недели в одну сторону.
- В Индии устройства Snow доставляются в течение одного-семи дней.
- В Соединённых Штатах Америки (США) доступны доставка на следующий день и доставка на второй день.
InboundShipment -> (структура)
Значения Status и TrackingNumber для устройства Snow, возвращаемого в Amazon Web Services для конкретной задачи.
Status -> (строка)
TrackingNumber -> (строка)
Номер отслеживания для этой задачи. Используя этот номер отслеживания на веб-сайте перевозчика вашего региона, вы можете отслеживать устройство Snow в процессе его перевозки.
Для Индии перевозчиком является Amazon Logistics. Во всех остальных регионах перевозчиком является UPS.
OutboundShipment -> (структура)
Значения Status и TrackingNumber для устройства Snow, доставляемого по указанному вами адресу для конкретной задачи.
Status -> (строка)
TrackingNumber -> (строка)
Номер отслеживания для этой задачи. Используя этот номер отслеживания на веб-сайте перевозчика вашего региона, вы можете отслеживать устройство Snow в процессе его перевозки.
Для Индии перевозчиком является Amazon Logistics. Во всех остальных регионах перевозчиком является UPS.
SnowballCapacityPreference -> (строка)
Предпочтение ёмкости устройства Snow для этой задачи, указанное при создании задачи. В регионах США вы можете выбрать Snowball ёмкостью 50 ТБ или 80 ТБ. Во всех остальных регионах используются Snowball ёмкостью 80 ТБ.
Для получения дополнительной информации см. “https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Типы устройств Snow Family и ёмкость) в Руководстве пользователя Snowcone или “https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Типы устройств Snow Family и ёмкость) в Руководстве пользователя Snowcone .
Notification -> (структура)
Настройки уведомлений Amazon Simple Notification Service (Amazon SNS), связанные с конкретной задачей. Объект Notification возвращается как часть синтаксиса ответа действия DescribeJob в типе данных JobMetadata.
SnsTopicARN -> (строка)
Новый SNS TopicArn, который вы хотите связать с этой задачей. Вы можете создавать идентификаторы ресурсов Amazon (ARN) для тем, используя действие Amazon SNS API CreateTopic.
Вы можете подписывать адреса электронной почты на тему Amazon SNS с помощью веб-консоли Amazon Web Services или с помощью действия Subscribe Amazon Simple Notification Service (Amazon SNS) API.
JobStatesToNotify -> (список)
Список состояний задач, которые будут запускать уведомление для этой задачи.
(строка)
NotifyAll -> (логическое значение)
DevicePickupSnsTopicARN -> (строка)
DataTransferProgress -> (структура)
Значение, определяющее реальный статус передачи данных устройства Snow в Amazon Web Services. Эти данные доступны только в то время, когда значение задачи имеет значение JobState, равное InProgress, как для задач импорта, так и экспорта.
BytesTransferred -> (длинное целое число)
ObjectsTransferred -> (длинное целое число)
TotalBytes -> (длинное целое число)
TotalObjects -> (длинное целое число)
JobLogInfo -> (структура)
Ссылки на предварительно подписанные URL-адреса Amazon S3 для отчёта и журналов о задаче. Для задач импорта отчёт о выполнении задачи PDF становится доступным в конце процесса импорта. Для задач экспорта отчёт о выполнении задачи обычно становится доступным во время доставки устройства Snow для вашей части задачи.
JobCompletionReportURI -> (строка)
JobSuccessLogURI -> (строка)
JobFailureLogURI -> (строка)
ClusterId -> (строка)
CID123e4567-e89b-12d3-a456-426655440000 .ForwardingAddressId -> (строка)
TaxDocuments -> (структура)
Метаданные, связанные с документами, необходимыми в вашем регионе Amazon Web Services.
IND -> (структура)
Документы, необходимые для налогообложения в регионе Amazon Web Services в Индии.
GSTIN -> (строка)
DeviceConfiguration -> (структура)
Контейнер для SnowconeDeviceConfiguration .
SnowconeDeviceConfiguration -> (структура)
Возвращает информацию о конфигурации устройства для задачи Snowcone.
WirelessConnection -> (структура)
Настраивает беспроводное соединение для устройства Snowcone.
IsWifiEnabled -> (логическое значение)
RemoteManagement -> (строка)
INSTALLED_AUTOSTART удалённое управление будет автоматически доступно по прибытии устройства к вам. В противном случае для управления устройством необходимо использовать Snowball Client.LongTermPricingId -> (string)
OnDeviceServiceConfiguration -> (structure)
Представляет метаданные и настройки конфигурации служб на устройстве Amazon Web Services Snow Family.
NFSOnDeviceService -> (structure)
Представляет службу NFS (Network File System) на устройстве Snow Family.
StorageLimit -> (integer)
StorageUnit -> (string)
Единица измерения объёма хранилища NFS на устройстве.
Допустимые значения: TB.
TGWOnDeviceService -> (structure)
Представляет службу Storage Gateway типа Tape Gateway на устройстве Snow Family.
StorageLimit -> (integer)
StorageUnit -> (string)
EKSOnDeviceService -> (structure)
Конфигурация EKS Anywhere на устройстве Snow Family.
KubernetesVersion -> (string)
EKSAnywhereVersion -> (string)
S3OnDeviceService -> (structure)
Конфигурация совместимого с Amazon S3 хранилища на устройствах Snow family.
StorageLimit -> (double)
StorageUnit -> (string)
ServiceSize -> (integer)
FaultTolerance -> (integer)
StorageLimit соответствует более чем одной конфигурации службы совместимого с Amazon S3 хранилища на устройствах Snow family.ImpactLevel -> (string)
PickupDetails -> (structure)
Информация, идентифицирующая лицо, забирающее устройство.
Name -> (string)
PhoneNumber -> (string)
Email -> (string)
IdentificationNumber -> (string)
IdentificationExpirationDate -> (timestamp)
IdentificationIssuingOrg -> (string)
DevicePickupId -> (string)
SnowballId -> (string)
SubJobMetadata -> (list)
Информация о конкретной части задания (в случае задания на экспорт), включая информацию об отправке, статус задания и другие важные метаданные.
(структура)
Содержит информацию о конкретном задании, включая информацию об отправке, статус задания и другие важные метаданные. Эта информация возвращается как часть синтаксиса ответа для действия DescribeJob.
JobId -> (строка)
JID123e4567-e89b-12d3-a456-426655440000.JobState -> (строка)
JobType -> (строка)
SnowballType -> (строка)
CreationDate -> (временная метка)
Resources -> (структура)
Массив объектов S3Resource. Каждый объект S3Resource представляет собой ведро Amazon S3, из которого или в которое будут экспортироваться/импортироваться ваши данные.
S3Resources -> (список)
Массив объектов S3Resource.
(структура)
Каждый объект S3Resource представляет собой ведро Amazon S3, из которого или в которое будут экспортироваться/импортироваться ваши данные. Для заданий на экспорт этот объект может иметь необязательное значение KeyRange. Длина диапазона определяется при создании задания и имеет либо включительный BeginMarker, либо включительный EndMarker, или оба. Диапазоны сортируются по бинарному представлению UTF-8.
BucketArn -> (строка)
KeyRange -> (структура)
Для заданий на экспорт можно указать необязательный KeyRange в конкретном ведре Amazon S3. Длина диапазона определяется при создании задания и имеет либо включительный BeginMarker, либо включительный EndMarker, или оба. Диапазоны сортируются по бинарному представлению UTF-8.
BeginMarker -> (строка)
EndMarker -> (строка)
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 -> (строка)
TransferOption -> (строка)
LambdaResources -> (список)
Функции Lambda на языке Python для этого задания.
(структура)
Идентификация
LambdaArn -> (строка)
EventTriggers -> (список)
Массив ARN объектов S3Resource, которые будут вызывать объекты LambdaResource, связанные с этим заданием.
(структура)
Контейнер для EventTriggerDefinition$EventResourceARN.
EventResourceARN -> (строка)
Ec2AmiResources -> (список)
Ассоциированные с этим заданием образы Amazon Machine Images (AMIs).
(структура)
Объект в формате JSON, содержащий идентификаторы образа Amazon Machine Image (AMI), включая идентификатор AMI, совместимый с Amazon EC2, и идентификатор AMI устройства Snow. Каждый AMI имеет эти два идентификатора для упрощения идентификации AMI как в облаке Amazon Web Services, так и на устройстве.
AmiId -> (строка)
SnowballAmiId -> (строка)
Description -> (строка)
KmsKeyARN -> (строка)
RoleARN -> (строка)
AddressId -> (строка)
ShippingDetails -> (структура)
Информация об отправке задания, включая номера отслеживания входящих и исходящих грузов и варианты скорости доставки.
ShippingOption -> (строка)
Скорость доставки для конкретного задания. Эта скорость не определяет, как скоро вы получите устройство Snow с момента создания задания. Эта скорость отражает, насколько быстро оно перемещается в пункт назначения во время транспортировки. Скорости региональной доставки следующие:
- В Австралии доступна экспресс-доставка. Обычно устройства Snow, доставленные экспресс-почтой, доставляются в течение одного дня.
- В странах Европейского союза (ЕС) доступна экспресс-доставка. Обычно устройства Snow, доставленные экспресс-почтой, доставляются в течение одного дня. Кроме того, большинство стран ЕС имеют доступ к стандартной доставке, которая обычно занимает менее недели в одну сторону.
- В Индии устройства Snow доставляются в течение одного-семи дней.
- В Соединенных Штатах Америки (США) доступны доставка на следующий день и доставка на два дня.
InboundShipment -> (структура)
Значения Status и TrackingNumber для устройства Snow, возвращаемого в Amazon Web Services для конкретного задания.
Status -> (строка)
TrackingNumber -> (строка)
Номер отслеживания этого задания. Используя этот номер отслеживания на веб-сайте перевозчика вашего региона, вы можете отслеживать устройство Snow во время транспортировки.
Для Индии перевозчиком является Amazon Logistics. Для всех других регионов - UPS.
OutboundShipment -> (структура)
Значения Status и TrackingNumber для устройства Snow, доставляемого по указанному вами адресу для конкретного задания.
Status -> (строка)
TrackingNumber -> (строка)
Номер отслеживания этого задания. Используя этот номер отслеживания на веб-сайте перевозчика вашего региона, вы можете отслеживать устройство Snow во время транспортировки.
Для Индии перевозчиком является Amazon Logistics. Для всех других регионов - UPS.
SnowballCapacityPreference -> (строка)
Предпочтение емкости устройства Snow для этого задания, указанное при его создании. В регионах США можно выбрать Snowball емкостью 50 ТБ или 80 ТБ. Во всех остальных регионах используется Snowball емкостью 80 ТБ.
Для получения дополнительной информации см. «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.
Notification -> (структура)
Настройки уведомлений Amazon Simple Notification Service (Amazon SNS), связанные с конкретным заданием. Объект Notification возвращается как часть синтаксиса ответа действия DescribeJob в типе данных JobMetadata.
SnsTopicARN -> (строка)
Новый SNS TopicArn, который вы хотите связать с этим заданием. Вы можете создавать идентификаторы ресурсов Amazon (ARN) для тем с помощью действия API CreateTopic Amazon SNS.
Вы можете подписывать адреса электронной почты на тему Amazon SNS через консоль управления Amazon Web Services или с помощью действия Subscribe Amazon Simple Notification Service (Amazon SNS) API.
JobStatesToNotify -> (список)
Список состояний задания, которые будут вызывать уведомление для этого задания.
(строка)
NotifyAll -> (логическое значение)
DevicePickupSnsTopicARN -> (строка)
DataTransferProgress -> (структура)
Значение, определяющее состояние в реальном времени передачи данных устройства Snow в Amazon Web Services. Эти данные доступны только в то время, когда задание имеет значение JobState, равное InProgress, как для импортных, так и для экспортных заданий.
BytesTransferred -> (целое число с плавающей запятой)
ObjectsTransferred -> (целое число с плавающей запятой)
TotalBytes -> (целое число с плавающей запятой)
TotalObjects -> (целое число с плавающей запятой)
JobLogInfo -> (структура)
Ссылки на предварительно подписанные URL-адреса Amazon S3 для отчета и журналов задания. Для импортных заданий отчет PDF о выполнении задания становится доступным в конце процесса импорта. Для экспортных заданий отчет о выполнении задания обычно становится доступным во время доставки устройства Snow для части задания.
JobCompletionReportURI -> (строка)
JobSuccessLogURI -> (строка)
JobFailureLogURI -> (строка)
ClusterId -> (строка)
CID123e4567-e89b-12d3-a456-426655440000.ForwardingAddressId -> (строка)
TaxDocuments -> (структура)
Метаданные, связанные с налоговыми документами, необходимыми в вашем регионе Amazon Web Services.
IND -> (структура)
Налоговые документы, необходимые в регионе Amazon Web Services в Индии.
GSTIN -> (строка)
DeviceConfiguration -> (структура)
Контейнер для SnowconeDeviceConfiguration.
SnowconeDeviceConfiguration -> (структура)
Возвращает информацию о конфигурации устройства для задания Snowcone.
WirelessConnection -> (структура)
Настраивает беспроводное подключение для устройства Snowcone.
IsWifiEnabled -> (булево)
RemoteManagement -> (строка)
INSTALLED_AUTOSTART, удалённое управление будет автоматически доступно при прибытии устройства к вам. В противном случае, для управления устройством требуется использовать Snowball Client.LongTermPricingId -> (строка)
OnDeviceServiceConfiguration -> (структура)
Представляет метаданные и настройки параметров сервисов на устройстве Amazon Web Services Snow Family.
NFSOnDeviceService -> (структура)
Представляет собой службу NFS (Network File System) на устройстве Snow Family.
StorageLimit -> (целое число)
StorageUnit -> (строка)
Единица измерения объема хранилища NFS на устройстве.
Допустимые значения: TB.
TGWOnDeviceService -> (структура)
Представляет собой службу Storage Gateway типа Tape Gateway на устройстве Snow Family.
StorageLimit -> (целое число)
StorageUnit -> (строка)
EKSOnDeviceService -> (структура)
Конфигурация EKS Anywhere на устройстве Snow Family.
KubernetesVersion -> (строка)
EKSAnywhereVersion -> (строка)
S3OnDeviceService -> (структура)
Конфигурация совместимого с Amazon S3 хранилища на устройствах Snow family.
StorageLimit -> (двойное число)
StorageUnit -> (строка)
ServiceSize -> (целое число)
FaultTolerance -> (целое число)
StorageLimit соответствует более чем одной конфигурации сервиса хранилища, совместимого с Amazon S3, на устройствах Snow family.ImpactLevel -> (строка)
PickupDetails -> (структура)
Информация, идентифицирующая человека, забирающего устройство.
Name -> (строка)
PhoneNumber -> (строка)
Email -> (строка)
IdentificationNumber -> (строка)
IdentificationExpirationDate -> (временная метка)
IdentificationIssuingOrg -> (строка)
DevicePickupId -> (строка)
SnowballId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.