Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

list-report-jobs

Описание

Возвращает сведения о заданиях отчетов.

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

Синтаксис

  list-report-jobs
[--by-report-plan-name <value>]
[--by-creation-before <value>]
[--by-creation-after <value>]
[--by-status <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--by-report-plan-name (строка)

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

--by-creation-before (метка времени)

Возвращает только задания отчетов, созданные до указанной даты и времени в формате Unix и по координированному всемирному времени (UTC). Например, значение 1516925490 соответствует пятнице, 26 января 2018 г., 00:11:30.

--by-creation-after (метка времени)

Возвращает только задания отчетов, созданные после указанной даты и времени в формате Unix и по координированному всемирному времени (UTC). Например, значение 1516925490 соответствует пятнице, 26 января 2018 г., 00:11:30.

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

Возвращает только задания отчетов, находящиеся в указанном состоянии. Состояния:

CREATED | RUNNING | COMPLETED | FAILED

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

Количество ожидаемых результатов от 1 до 1000. Необязательно. Если не указано, запрос вернет 1 МБ данных.

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

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

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

Вывод

ReportJobs -> (список)

Подробная информация о ваших заданиях по созданию отчетов в формате JSON.

(структура)

Содержит подробную информацию о задании по созданию отчета. Задание по созданию отчета собирает отчет на основе плана отчета и публикует его в Amazon S3.

ReportJobId -> (строка)

Идентификатор задания по созданию отчета. Уникальная, случайным образом сгенерированная строка Unicode, закодированная в UTF-8, длина которой не превышает 1024 байта. Идентификаторы заданий по созданию отчета изменить нельзя.

ReportPlanArn -> (строка)

Идентификатор Amazon Resource Name (ARN), уникально определяющий ресурс. Формат ARN зависит от типа ресурса.

ReportTemplate -> (строка)

Идентифицирует шаблон отчета для отчета. Отчеты создаются с использованием шаблона отчета. Шаблоны отчетов:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

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

Дата и время создания задания по созданию отчета в формате Unix и по Гринвичу (UTC). Значение CreationTime точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

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

Дата и время завершения задания по созданию отчета в формате Unix и по Гринвичу (UTC). Значение CompletionTime точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

Status -> (строка)

Статус задания по созданию отчета. Статусы:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED означает, что отчет доступен для просмотра в указанном пункте назначения. Если статус равен FAILED, ознакомьтесь с StatusMessage, чтобы узнать причину.

StatusMessage -> (строка)

Сообщение, поясняющее статус задания по созданию отчета.

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

Имя корзины S3 и ключи S3 для пункта назначения, куда задание по созданию отчета публикует отчет.

S3BucketName -> (строка)

Уникальное имя корзины Amazon S3, которая получает ваши отчеты.

S3Keys -> (список)

Ключ объекта, который уникально идентифицирует ваши отчеты в вашей корзине S3.

(строка)

NextToken -> (строка)

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

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

Spec-Zone.ru

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