Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

ограничения-использования

Описание

Отображает ограничения использования кластера. Результаты фильтруются на основе сочетания входного идентификатора ограничения использования, идентификатора кластера и типа функции:

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

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

describe-usage-limits является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query с постраничным ответом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: UsageLimits

Синтаксис

  describe-usage-limits
[--usage-limit-id <value>]
[--cluster-identifier <value>]
[--feature-type <value>]
[--tag-keys <value>]
[--tag-values <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]

Параметры

--usage-limit-id (строка)

Идентификатор ограничения использования для описания.

--cluster-identifier (строка)

Идентификатор кластера, для которого вы хотите описать ограничения использования.

--feature-type (строка)

Тип функции, для которого вы хотите описать ограничения использования.

Возможные значения:

  • spectrum
  • concurrency-scaling
  • cross-region-datasharing

--tag-keys (список)

Ключ или ключи тега, для которых вы хотите вернуть все соответствующие объекты ограничений использования, связанные с указанным ключом или ключами. Например, предположим, что у вас есть группы параметров, помеченные ключами owner и environment. Если вы укажете оба эти ключа тега в запросе, Amazon Redshift вернёт ответ с объектами ограничений использования, имеющими либо тот, либо другой, либо оба этих тега.

(строка)

Синтаксис:

"string" "string" ...

--tag-values (список)

Значение или значения тега, для которых вы хотите вернуть все соответствующие объекты ограничений использования, связанные с указанным значением или значениями тега. Например, предположим, что у вас есть группы параметров, помеченные значениями admin и test. Если вы укажете оба этих значения тега в запросе, Amazon Redshift вернёт ответ с объектами ограничений использования, имеющими либо тот, либо другой, либо оба этих значения тега.

(строка)

Синтаксис:

"string" "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-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

ОграниченияИспользования -> (список)

Содержит вывод действия DescribeUsageLimits.

(структура)

Описывает объект ограничения использования для кластера.

ИдентификаторОграниченияИспользования -> (строка)

Идентификатор ограничения использования.

ИдентификаторКластера -> (строка)

Идентификатор кластера с ограничением использования.

ТипФункции -> (строка)

Функция Amazon Redshift, к которой относится ограничение.

ТипОграничения -> (строка)

Тип ограничения. В зависимости от типа функции, это может быть продолжительность времени или размер данных.

Значение -> (длинное целое число)

Значение ограничения. Если это ограничение по времени, это значение в минутах. Если это ограничение по данным, это значение в терабайтах (TB).

Период -> (строка)

Период времени, к которому относится значение. Период weekly начинается в воскресенье. По умолчанию — monthly.

ДействиеПриНарушении -> (строка)

Действие, которое выполняет Amazon Redshift при достижении ограничения. Возможные значения:

  • лог — для записи события в системной таблице. По умолчанию — лог.
  • отправить-метрику — для отправки метрик CloudWatch.
  • отключить — для отключения функции до начала следующего периода использования.

Теги -> (список)

Список экземпляров тега.

(структура)

Тег, состоящий из пары имя/значение для ресурса.

Ключ -> (строка)

Ключ или имя для тега ресурса.

Значение -> (строка)

Значение для тега ресурса.

Маркер -> (строка)

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

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

Spec-Zone.ru

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