Spec-Zone.ru › AWS CLI v2

[ aws . glacier ]

describe-job

Описание

Эта операция возвращает информацию о задании, которое вы ранее инициировали, включая дату инициирования задания, пользователя, который инициировал задание, код/сообщение состояния задания и Amazon SNS-тему для уведомлений после завершения задания Amazon S3 Glacier (Glacier). Для получения дополнительной информации об инициировании задания см. InitiateJob.

Примечание

Эта операция позволяет проверять статус вашего задания. Тем не менее, настоятельно рекомендуется настроить Amazon SNS-тему и указать её в запросе на инициирование задания, чтобы Glacier мог уведомлять тему после завершения задания.

Идентификатор задания не истекает в течение как минимум 24 часов после завершения задания Glacier.

У AWS-аккаунта есть полные права для выполнения всех операций (действий). Однако пользователи AWS Identity and Access Management (IAM) по умолчанию не обладают никакими правами. Вам необходимо предоставить им явные разрешения для выполнения определённых действий. Для получения дополнительной информации см. Управление доступом с помощью AWS Identity and Access Management (IAM).

Дополнительную информацию об использовании этой операции можно найти в документации к соответствующему REST API Describe Job в Руководстве разработчика Amazon Glacier.

См. также: AWS API Documentation

Синтаксис

  describe-job
--account-id <value>
--vault-name <value>
--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]

Параметры

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

Значение AccountId — это идентификатор AWS-аккаунта, которому принадлежит хранилище. Вы можете указать идентификатор AWS-аккаунта или, по желанию, один символ ‘-’ (дефис), в этом случае Amazon S3 Glacier использует идентификатор AWS-аккаунта, связанный с учётными данными, используемыми для подписи запроса. Если вы используете идентификатор аккаунта, не включайте в него дефисы (‘-’).

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

Имя хранилища.

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

Идентификатор задания, которое требуется описать.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставляемому --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, полученные из JSON. Невозможно передавать произвольные двоичные значения, используя JSON-строку, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение по умолчанию или значение input, выводит пример входного JSON, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет выведен пример входного YAML, который может быть использован с --cli-input-yaml. Если предоставлено значение output, оно валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладку.

--endpoint-url (строка)

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

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

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

Примеры

Примечание

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

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

Следующая команда извлекает информацию о задании извлечения инвентаря в хранилище с именем my-vault:

aws glacier describe-job --account-id - --vault-name my-vault --job-id zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW

Вывод:

{
    "InventoryRetrievalParameters": {
        "Format": "JSON"
    },
    "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault",
    "Completed": false,
    "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW",
    "Action": "InventoryRetrieval",
    "CreationDate": "2015-07-17T20:23:41.616Z",
    "StatusCode": "InProgress"
}

Идентификатор задания можно найти в выводе aws glacier initiate-job и aws glacier list-jobs. Amazon Glacier требует аргумент идентификатора аккаунта при выполнении операций, но вы можете использовать дефис для указания используемого аккаунта.

Вывод

JobId -> (строка)

Непрозрачная строка, идентифицирующая задачу Amazon S3 Glacier.

JobDescription -> (строка)

Описание задачи, предоставленное при инициировании задачи.

Action -> (строка)

Тип задачи. Это значение может быть ArchiveRetrieval , InventoryRetrieval или Select .

ArchiveId -> (строка)

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

VaultARN -> (строка)

Идентификатор ресурса Amazon (ARN) хранилища, из которого был запрошен запрос на извлечение архива.

CreationDate -> (строка)

Дата UTC создания задачи. Это значение представляет собой строковое представление формата даты ISO 8601, например "2012-03-20T17:03:43.221Z" .

Completed -> (булево)

Статус задачи. Когда задача завершена, вы можете получить выходные данные задачи с помощью Get Job Output (GET output).

StatusCode -> (строка)

Код состояния может быть InProgress , Succeeded или Failed и указывает статус задачи.

StatusMessage -> (строка)

Полезное сообщение, описывающее статус задачи.

ArchiveSizeInBytes -> (длинное целое число)

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

InventorySizeInBytes -> (длинное целое число)

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

SNSTopic -> (строка)

Тема Amazon SNS, которая получает уведомление.

CompletionDate -> (строка)

Время UTC завершения запроса задачи. Пока задача выполняется, значение равно null.

SHA256TreeHash -> (строка)

Для задачи извлечения архива это значение представляет собой контрольную сумму архива. В противном случае это значение равно null.

Значение SHA256 хеша дерева для запрошенного диапазона архива. Если запрос InitiateJob для архива указал диапазон, выровненный с хешем дерева, то это поле возвращает значение.

Если извлекается весь архив, это значение совпадает со значением ArchiveSHA256TreeHash.

Это поле равно null в следующих случаях:

  • Задачи извлечения архива, которые задают диапазон, не выровненный с хешем дерева
  • Задачи архивирования, которые задают диапазон, равный всему архиву, когда статус задачи равен InProgress
  • Задачи инвентаризации
  • Задачи выбора

ArchiveSHA256TreeHash -> (строка)

Значение SHA256 хеша дерева всего архива для извлечения архива. Для задач извлечения инвентаризации или выбора это поле равно null.

RetrievalByteRange -> (строка)

Диапазон извлеченных байтов для задач извлечения архивов в формате StartByteValue -EndByteValue . Если диапазон не был указан при извлечении архива, то извлекается весь архив. В этом случае StartByteValue равно 0, а EndByteValue равно размеру архива минус 1. Для задач извлечения инвентаризации или выбора это поле равно null.

Tier -> (строка)

Используемый уровень для задач выбора или извлечения архива. Допустимые значения — Expedited , Standard или Bulk . Standard является значением по умолчанию.

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

Параметры, используемые для извлечения инвентаризации диапазона.

Format -> (строка)

Формат вывода списка инвентаризации хранилища, который устанавливается запросом InitiateJob при инициировании задачи для извлечения инвентаризации хранилища. Допустимые значения — CSV и JSON .

StartDate -> (строка)

Начало диапазона дат в формате Всемирное координированное время (UTC) для извлечения инвентаризации хранилища, которое включает архивы, созданные в или после этой даты. Это значение должно быть строкой в формате даты ISO 8601, например 2013-03-20T17:03:43Z .

EndDate -> (строка)

Конец диапазона дат в UTC для извлечения инвентаризации хранилища, которое включает архивы, созданные до этой даты. Это значение должно быть строкой в формате даты ISO 8601, например 2013-03-20T17:03:43Z .

Limit -> (строка)

Максимальное количество элементов инвентаризации, возвращаемых за один запрос извлечения инвентаризации хранилища. Это ограничение устанавливается при инициировании задачи с запросом InitiateJob.

Marker -> (строка)

Непрозрачная строка, представляющая собой место продолжения постраничной обработки результатов извлечения инвентаризации хранилища. Вы используете маркер в новом запросе InitiateJob для получения дополнительных элементов инвентаризации. Если больше элементов инвентаризации нет, это значение равно null . Дополнительную информацию см. в разделе Извлечение инвентаризации диапазона.

JobOutputPath -> (строка)

Содержит расположение выходных данных задачи.

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

Содержит параметры, используемые для выбора.

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

Описание формата сериализации объекта.

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

Описание сериализации объекта в формате CSV.

FileHeaderInfo -> (строка)

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

Comments -> (строка)

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

QuoteEscapeCharacter -> (строка)

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

RecordDelimiter -> (строка)

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

FieldDelimiter -> (строка)

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

QuoteCharacter -> (строка)

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

ExpressionType -> (строка)

Тип предоставленного выражения, например SQL .

Expression -> (строка)

Выражение, используемое для выбора объекта.

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

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

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

Описание сериализации результатов запроса в формате CSV.

QuoteFields -> (строка)

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

QuoteEscapeCharacter -> (строка)

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

RecordDelimiter -> (строка)

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

FieldDelimiter -> (строка)

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

QuoteCharacter -> (строка)

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

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

Содержит расположение, где хранятся данные из задачи выбора.

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

Описание расположения S3, которое будет получать результаты запроса задачи.

BucketName -> (строка)

Имя ведра Amazon S3, в котором хранятся результаты задачи.

Prefix -> (строка)

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

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

Содержит информацию об использовании шифрования для хранения результатов задачи в Amazon S3.

EncryptionType -> (строка)

Алгоритм шифрования на стороне сервера, используемый при хранении результатов задачи в Amazon S3, например AES256 или aws:kms .

KMSKeyId -> (строка)

Идентификатор ключа AWS KMS, используемый для шифрования объекта. Все запросы GET и PUT для объекта, защищенного AWS KMS, завершаются неудачно, если не выполняются с использованием Secure Sockets Layer (SSL) или Signature Version 4.

KMSContext -> (строка)

Необязательно. Если тип шифрования — aws:kms , вы можете использовать это значение для указания контекста шифрования для результатов задачи.

CannedACL -> (строка)

Список предварительно настроенных правил доступа (ACL), применяемых к результатам задачи.

AccessControlList -> (список)

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

(структура)

Содержит информацию о разрешении.

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

Получатель.

Type -> (строка)

Тип получателя

DisplayName -> (строка)

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

URI -> (строка)

URI группы получателей.

ID -> (строка)

Канонический идентификатор пользователя получателя.

EmailAddress -> (строка)

Электронный адрес получателя.

Permission -> (строка)

Указывает предоставленное получателю разрешение.

Tagging -> (карта)

Набор тегов, применяемых к результатам задачи.

key -> (строка)

value -> (строка)

UserMetadata -> (карта)

Карта метаданных для хранения с результатами задачи в Amazon S3.

key -> (строка)

value -> (строка)

StorageClass -> (строка)

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

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

Spec-Zone.ru

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