Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

describe-export-tasks

Описание

Отображает указанные задачи экспорта. Вы можете отобразить все задачи экспорта или отфильтровать результаты по идентификатору задачи или статусу задачи.

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

describe-export-tasks является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: exportTasks

Синтаксис

  describe-export-tasks
[--task-id <value>]
[--status-code <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

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

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

--status-code (строка)

Код состояния задачи экспорта. Указание кода состояния фильтрует результаты до нуля или более задач экспорта.

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

  • CANCELLED
  • COMPLETED
  • FAILED
  • PENDING
  • PENDING_CANCEL
  • RUNNING

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

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

Маркер, указывающий, где следует начать постраничную обработку. Это NextToken из ранее укороченного ответа.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя командной строки AWS.

--page-size (целое число)

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

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя командной строки AWS.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя командной строки AWS.

--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-auto-prompt (логическое значение)

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

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

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

Вывод

exportTasks -> (список)

Задачи экспорта.

(структура)

Представляет задачу экспорта.

taskId -> (строка)

Идентификатор задачи экспорта.

taskName -> (строка)

Имя задачи экспорта.

logGroupName -> (строка)

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

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

Время начала, выраженное в миллисекундах после Jan 1, 1970 00:00:00 UTC. События с отметкой времени до этой даты не экспортируются.

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

Время окончания, выраженное в миллисекундах после Jan 1, 1970 00:00:00 UTC. События с отметкой времени позже этой даты не экспортируются.

destination -> (строка)

Имя ведра S3, в которое были экспортированы данные журналов.

destinationPrefix -> (строка)

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

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

Статус задачи экспорта.

code -> (строка)

Код состояния задачи экспорта.

message -> (строка)

Сообщение состояния, связанное с кодом состояния.

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

Информация об исполнении задачи экспорта.

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

Время создания задачи экспорта, выраженное в миллисекундах после Jan 1, 1970 00:00:00 UTC.

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

Время завершения задачи экспорта, выраженное в миллисекундах после Jan 1, 1970 00:00:00 UTC.

nextToken -> (строка)

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

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

Spec-Zone.ru

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