Spec-Zone.ru › AWS CLI v2

[ aws . s3control ]

list-jobs

Описание

Перечисляет текущие задания S3 Batch Operations, а также задания, завершившиеся в течение последних 90 дней для учётной записи Amazon Web Services, делающей запрос. Для получения дополнительной информации, см. раздел S3 Batch Operations в Руководстве пользователя Amazon S3.

Разрешения

Для использования операции ListJobs, необходимо иметь разрешение на выполнение действия s3:ListJobs.

Связанные действия включают:

  • CreateJob
  • DescribeJob
  • UpdateJobPriority
  • UpdateJobStatus

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

Синтаксис

  list-jobs
--account-id <value>
[--job-statuses <value>]
[--next-token <value>]
[--max-results <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 (строка)

Идентификатор учётной записи Amazon Web Services, связанной с заданием S3 Batch Operations.

--job-statuses (список)

Запрос List Jobs возвращает задания, соответствующие статусам, перечисленным в этом элементе.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Active
  Cancelled
  Cancelling
  Complete
  Completing
  Failed
  Failing
  New
  Paused
  Pausing
  Preparing
  Ready
  Suspended

--next-token (строка)

Маркер для запроса следующей страницы результатов. Используйте маркер, возвращённый Amazon S3 в элементе NextToken ответа ListJobsResult по предыдущему запросу List Jobs.

--max-results (целое число)

Максимальное количество заданий, которое Amazon S3 включит в ответ List Jobs. Если заданий больше, чем это число, ответ будет содержать маркер страницы в поле NextToken для получения следующей страницы результатов.

--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.

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Подробнее см. руководство «Начало работы» в Руководстве пользователя AWS CLI.

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

Чтобы перечислить задания Amazon S3 Batch Operations для учётной записи

Следующий list-jobs пример перечисляет все недавние задания обработки пакетных операций для указанной учётной записи.

aws s3control list-jobs \
    --account-id 123456789012

Вывод:

{
    "Jobs": [
        {
            "Operation": "S3PutObjectTagging",
            "ProgressSummary": {
                "NumberOfTasksFailed": 0,
                "NumberOfTasksSucceeded": 8,
                "TotalNumberOfTasks": 8
            },
            "CreationTime": "2019-10-03T21:48:48.048Z",
            "Status": "Complete",
            "JobId": "93735294-df46-44d5-8638-6356f335324e",
            "Priority": 42
        },
        {
            "Operation": "S3PutObjectTagging",
            "ProgressSummary": {
                "NumberOfTasksFailed": 0,
                "NumberOfTasksSucceeded": 0,
                "TotalNumberOfTasks": 0
            },
            "CreationTime": "2019-10-03T21:46:07.084Z",
            "Status": "Failed",
            "JobId": "3f3c7619-02d3-4779-97f6-1d98dd313108",
            "Priority": 42
        },
    ]
}

Вывод

NextToken -> (строка)

Если запрос List Jobs произвёл больше, чем максимальное количество результатов, вы можете передать это значение в последующий запрос List Jobs для получения следующей страницы результатов.

Jobs -> (список)

Список текущих заданий и заданий, завершившихся в течение последних 30 дней.

(структура)

Содержит информацию о конфигурации и состоянии одного задания, полученного как часть списка заданий.

JobId -> (строка)

Идентификатор указанного задания.

Description -> (строка)

Пользовательское описание, включённое в запрос Create Job указанного задания.

Operation -> (строка)

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

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

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

Status -> (строка)

Текущий статус указанного задания.

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

Метка времени, указывающая, когда указанное задание было создано.

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

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

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

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

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

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

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

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

Атрибут JobTimers сводного отчёта о прогрессе задания.

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

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

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

Spec-Zone.ru

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