list-report-plans
Описание
Возвращает список ваших планов отчетов. Для получения подробной информации об одном плане отчета используйте DescribeReportPlan .
См. также: Документация API AWS
Синтаксис
list-report-plans
[--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]
Параметры
--max-results (целое число)
--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
- 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.
Вывод
ReportPlans -> (список)
Планы отчетов с подробной информацией для каждого плана. Эта информация включает Amazon Resource Name (ARN), имя плана отчета, описание, настройки, канал доставки, статус развертывания, время создания и последние попытки запуска и успешного выполнения плана отчета.
(структура)
Содержит подробную информацию о плане отчета.
ReportPlanArn -> (строка)
ReportPlanName -> (строка)
ReportPlanDescription -> (строка)
ReportSetting -> (структура)
Идентифицирует шаблон отчета для отчета. Отчеты создаются с использованием шаблона отчета. Шаблоны отчетов:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORTЕсли шаблон отчета является RESOURCE_COMPLIANCE_REPORT или CONTROL_COMPLIANCE_REPORT, этот ресурс API также описывает охват отчета регионами Amazon Web Services и фреймворками.
ReportTemplate -> (строка)
Идентифицирует шаблон отчета для отчета. Отчеты создаются с использованием шаблона отчета. Шаблоны отчетов:
RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORTFrameworkArns -> (список)
Amazon Resource Names (ARN) фреймворков, охватываемых отчетом.
(строка)
NumberOfFrameworks -> (целое число)
Accounts -> (список)
Это счета, которые должны быть включены в отчет.
Используйте строковое значение ROOT для включения всех организационных подразделений.
(строка)
OrganizationUnits -> (список)
Это организационные подразделения, которые должны быть включены в отчет.
(строка)
Regions -> (список)
Это регионы, которые должны быть включены в отчет.
Используйте символ подстановки в качестве строкового значения для включения всех регионов.
(строка)
ReportDeliveryChannel -> (структура)
Содержит информацию о месте и способе доставки отчетов, в частности, имя вашего Amazon S3-бакета, префикс ключа S3 и форматы ваших отчетов.
S3BucketName -> (строка)
S3KeyPrefix -> (строка)
prefix /Backup/us-west-2/год/месяц/день/имя-отчета. Если не указано, префикса нет.Formats -> (список)
Формат ваших отчетов: CSV , JSON или оба. Если не указано, используется формат по умолчанию CSV .
(строка)
DeploymentStatus -> (строка)
Статус развертывания плана отчета. Статусы:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETEDCreationTime -> (временная метка)
CreationTime точное до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.LastAttemptedExecutionTime -> (временная метка)
LastAttemptedExecutionTime точное до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.LastSuccessfulExecutionTime -> (временная метка)
LastSuccessfulExecutionTime точное до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.