Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

describe-refresh-schedule

Описание

Предоставляет сводку расписания обновления.

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

Синтаксис

  describe-refresh-schedule
--aws-account-id <value>
--data-set-id <value>
--schedule-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]

Параметры

--aws-account-id (строка)

Идентификатор учетной записи Amazon Web Services.

--data-set-id (строка)

Идентификатор набора данных.

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

Идентификатор расписания обновления.

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

Вывод

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

Расписание обновления.

ScheduleId -> (строка)

Идентификатор расписания обновления.

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

Частота расписания обновления.

Interval -> (строка)

Интервал между запланированными обновлениями. Допустимые значения следующие:

  • MINUTE15 : Набор данных обновляется каждые 15 минут. Это значение поддерживается только для инкрементных обновлений. Этот интервал может использоваться только для одного расписания на набор данных.
  • MINUTE30 : Набор данных обновляется каждые 30 минут. Это значение поддерживается только для инкрементных обновлений. Этот интервал может использоваться только для одного расписания на набор данных.
  • HOURLY : Набор данных обновляется каждый час. Этот интервал может использоваться только для одного расписания на набор данных.
  • DAILY : Набор данных обновляется каждый день.
  • WEEKLY : Набор данных обновляется каждую неделю.
  • MONTHLY : Набор данных обновляется каждый месяц.

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

День недели, на который вы хотите запланировать обновление. Это значение требуется для еженедельных и ежемесячных интервалов обновления.

DayOfWeek -> (строка)

День недели, на который вы хотите запланировать обновление.

DayOfMonth -> (строка)

Число месяца, на которое вы хотите запланировать обновление.

Timezone -> (строка)

Часовой пояс, который вы хотите использовать для расписания обновления. Идентификатор часового пояса должен соответствовать соответствующему идентификатору, найденному на java.util.time.getAvailableIDs().

TimeOfTheDay -> (строка)

Время дня, когда вы хотите обновить набор данных. Это значение выражается в формате ЧЧ:ММ. Это поле не требуется для расписаний, обновляющихся каждый час.

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

Время после которого можно начать расписание обновления, выраженное в формате YYYY-MM-DDTHH:MM:SS.

RefreshType -> (строка)

Тип обновления, который проходит набор данных. Допустимые значения следующие:

  • FULL_REFRESH : Полное обновление набора данных.
  • INCREMENTAL_REFRESH : Частичное обновление некоторых строк набора данных на основе заданного временного интервала.

Дополнительную информацию о полных и инкрементных обновлениях см. в разделе «Обновление данных SPICE» в Руководстве пользователя Amazon QuickSight.

Arn -> (строка)

Amazon Resource Name (ARN) для расписания обновления.

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

HTTP-статус запроса.

RequestId -> (строка)

Идентификатор запроса Amazon Web Services для данной операции.

Arn -> (строка)

Amazon Resource Name (ARN) для расписания обновления.

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

Spec-Zone.ru

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