Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

describe-report-job

Описание

Возвращает детали, связанные с созданием отчёта, указанные его ReportJobId .

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

Синтаксис

  describe-report-job
--report-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]

Параметры

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

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

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

Вывод

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

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

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.

(строка)

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

Spec-Zone.ru

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