describe-scheduled-actions
Описание
Описывает свойства запланированных действий.
См. также: Документация API AWS
describe-scheduled-actions — это страничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить страничную навигацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с страничной навигацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ScheduledActions
Синтаксис
describe-scheduled-actions
[--scheduled-action-name <value>]
[--target-action-type <value>]
[--start-time <value>]
[--end-time <value>]
[--active | --no-active]
[--filters <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]
Параметры
--scheduled-action-name (строка)
--target-action-type (строка)
Тип запланированных действий для получения.
Возможные значения:
ResizeClusterPauseClusterResumeCluster
--start-time (метка времени)
--end-time (метка времени)
--active | --no-active (логическое значение)
--filters (список)
Список фильтров запланированных действий.
(структура)
Набор элементов для фильтрации возвращаемых запланированных действий.
Имя -> (строка)
Значения -> (список)
Список значений. Сравнивается, если значение (типа, определенного Name ) равно элементу в списке запланированных действий.
(строка)
Сокращенный синтаксис:
Name=string,Values=string,string ...
Синтаксис JSON:
[
{
"Name": "cluster-identifier"|"iam-role",
"Values": ["string", ...]
}
...
]
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала страничной навигации. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Страничная навигация в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймауты вызовов AWS-сервиса.
Примеры использования см. в разделе Страничная навигация в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления страничной навигации укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Страничная навигация в Руководстве пользователя AWS Command Line Interface.
--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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила кавычек Unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам кавычек вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для описания запланированных действий
Следующий пример describe-scheduled-actions отображает подробности для любых запланированных действий.
aws redshift describe-scheduled-actions
Вывод:
{
"ScheduledActions": [
{
"ScheduledActionName": "resizecluster",
"TargetAction": {
"ResizeCluster": {
"ClusterIdentifier": "mycluster",
"NumberOfNodes": 4,
"Classic": false
}
},
"Schedule": "at(2019-12-10T00:07:00)",
"IamRole": "arn:aws:iam::123456789012:role/myRedshiftRole",
"State": "ACTIVE",
"NextInvocations": [
"2019-12-10T00:07:00Z"
]
}
]
}
Вывод
Маркер -> (строка)
MaxRecords, Amazon Web Services возвращает значение в поле Marker ответа. Вы можете получить следующий набор записей ответов, предоставив возвращённое значение маркера в параметре Marker и повторив запрос.ScheduledActions -> (список)
Список полученных запланированных действий.
(структура)
Описание запланированного действия. Вы можете использовать запланированное действие для запуска некоторых операций API Amazon Redshift по расписанию. Сведения о поддерживаемых операциях API, которые могут быть запланированы, см. в ScheduledActionType.
ScheduledActionName -> (строка)
TargetAction -> (структура)
Строка в формате JSON операции API Amazon Redshift с входными параметрами.
“{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} “.
ResizeCluster -> (структура)
Действие, выполняющее операцию API ResizeCluster.
ClusterIdentifier -> (строка)
ClusterType -> (строка)
NodeType -> (строка)
NumberOfNodes -> (целое число)
Classic -> (булево)
false, тип изменения размеров является эластичным.ReservedNodeId -> (строка)
TargetReservedNodeOfferingId -> (строка)
PauseCluster -> (структура)
Действие, выполняющее операцию API PauseCluster.
ClusterIdentifier -> (строка)
ResumeCluster -> (структура)
Действие, выполняющее операцию API ResumeCluster.
ClusterIdentifier -> (строка)
Schedule -> (строка)
Расписание для одноразового (в формате at) или повторяющегося (в формате cron) запланированного действия. Вызовы расписания должны быть разделены как минимум одним часом.
Формат выражений at — “at(yyyy-mm-ddThh:mm:ss) “. Например, “at(2016-03-04T17:27:00) “.
Формат выражений cron — “cron(Minutes Hours Day-of-month Month Day-of-week Year) “. Например, “cron(0 10 ? * MON *) “. Дополнительные сведения см. в разделе Cron Expressions в Руководстве пользователя Amazon CloudWatch Events.
IamRole -> (строка)
ScheduledActionDescription -> (строка)
State -> (строка)
DISABLED.NextInvocations -> (список)
Список моментов времени, когда запланированное действие будет выполнено.
(метка времени)
StartTime -> (метка времени)
EndTime -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.