Spec-Zone.ru › AWS CLI v2

[ aws . freetier ]

get-free-tier-usage

Description

Возвращает список всех объектов использования Free Tier, которые соответствуют вашим фильтрам.

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

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

Synopsis

  get-free-tier-usage
[--filter <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]

Options

--filter (structure)

Выражение, указывающее условия, которые вы хотите, чтобы каждый объект FreeTierUsage удовлетворял.

And -> (list)

Возвращает результаты, соответствующие всем Expressions, которые вы указали в массиве.

(structure)

Используйте Expression для фильтрации в операции API GetFreeTierUsage.

Вы можете использовать следующие шаблоны:

  • Простые значения измерений (Dimensions корневой оператор)
  • Сложные выражения с логическими операторами (AND , NOT и OR корневые операторы).

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

Пример простых значений измерений

Вы можете отфильтровать для точного соответствия REGION==us-east-1 OR REGION==us-west-1.

Соответствующий Expression выглядит следующим образом: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] } }

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

Для сложных выражений с логическими операторами можно использовать вложенные выражения, чтобы использовать логические операторы и указать расширенную фильтрацию.

Пример сложных выражений с логическими операторами

Вы можете фильтровать по ((REGION == us-east-1 OR REGION == us-west-1) OR (SERVICE CONTAINS AWSLambda)) AND (USAGE_TYPE !CONTAINS DataTransfer).

Соответствующий Expression выглядит следующим образом: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] }}, {"Dimensions": { "Key": "SERVICE", "Values": ["AWSLambda"], "MatchOptions": ["CONTAINS"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"], "MatchOptions": ["CONTAINS"] }}} ] }

В следующем разделе Содержимое необходимо указать ровно один из следующих корневых операторов.

And -> (list)

Возвращает результаты, соответствующие всем Expressions, которые вы указали в массиве.

( … recursive … )

Dimensions -> (structure)

Конкретное измерение, значения и тип соответствия для фильтрации объектов.

Key -> (string)

Имя измерения, по которому вы хотите выполнить фильтрацию.

MatchOptions -> (list)

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

(string)

Values -> (list)

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

(string)

( … recursive … )Or -> (list)

Возвращает результаты, соответствующие любому из Expressions, которые вы указали. в массиве.

( … recursive … )

Dimensions -> (structure)

Конкретное измерение, значения и тип соответствия для фильтрации объектов.

Key -> (string)

Имя измерения, по которому вы хотите выполнить фильтрацию.

MatchOptions -> (list)

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

(string)

Values -> (list)

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

(string)

Not -> (structure)

Возвращает результаты, которые не соответствуют Expression, который вы указали.

And -> (list)

Возвращает результаты, соответствующие всем Expressions, которые вы указали в массиве.

( … recursive … )

Dimensions -> (structure)

Конкретное измерение, значения и тип соответствия для фильтрации объектов.

Key -> (string)

Имя измерения, по которому вы хотите выполнить фильтрацию.

MatchOptions -> (list)

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

(string)

Values -> (list)

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

(string)

( … recursive … )Or -> (list)

Возвращает результаты, соответствующие любому из Expressions, которые вы указали. в массиве.

( … recursive … )

Or -> (list)

Возвращает результаты, соответствующие любому из Expressions, которые вы указали. в массиве.

(structure)

Используйте Expression для фильтрации в операции API GetFreeTierUsage.

Вы можете использовать следующие шаблоны:

  • Простые значения измерений (Dimensions корневой оператор)
  • Сложные выражения с логическими операторами (AND , NOT , и OR корневые операторы).

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

Пример простых значений измерений

Вы можете отфильтровать для точного соответствия REGION==us-east-1 OR REGION==us-west-1.

Соответствующий Expression выглядит следующим образом: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] } }

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

Для сложных выражений с логическими операторами можно использовать вложенные выражения, чтобы использовать логические операторы и указать расширенную фильтрацию.

Пример сложных выражений с логическими операторами

Вы можете фильтровать по ((REGION == us-east-1 OR REGION == us-west-1) OR (SERVICE CONTAINS AWSLambda)) AND (USAGE_TYPE !CONTAINS DataTransfer).

Соответствующий Expression выглядит следующим образом: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] }}, {"Dimensions": { "Key": "SERVICE", "Values": ["AWSLambda"], "MatchOptions": ["CONTAINS"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"], "MatchOptions": ["CONTAINS"] }}} ] }

В следующем разделе Содержимое необходимо указать ровно один из следующих корневых операторов.

And -> (list)

Возвращает результаты, соответствующие всем Expressions, которые вы указали в массиве.

( … recursive … )

Dimensions -> (structure)

Конкретное измерение, значения и тип соответствия для фильтрации объектов.

Key -> (string)

Имя измерения, по которому вы хотите выполнить фильтрацию.

MatchOptions -> (list)

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

(string)

Values -> (list)

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

(string)

( … recursive … )Or -> (list)

Возвращает результаты, соответствующие любому из Expressions, которые вы указали. в массиве.

( … recursive … )

Синтаксис JSON:

{
  "And": [
    {
      "And": [
        { ... recursive ... }
        ...
      ],
      "Dimensions": {
        "Key": "SERVICE"|"OPERATION"|"USAGE_TYPE"|"REGION"|"FREE_TIER_TYPE"|"DESCRIPTION"|"USAGE_PERCENTAGE",
        "MatchOptions": ["EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL", ...],
        "Values": ["string", ...]
      },
      "Not": { ... recursive ... },
      "Or": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ],
  "Dimensions": {
    "Key": "SERVICE"|"OPERATION"|"USAGE_TYPE"|"REGION"|"FREE_TIER_TYPE"|"DESCRIPTION"|"USAGE_PERCENTAGE",
    "MatchOptions": ["EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL", ...],
    "Values": ["string", ...]
  },
  "Not": {
    "And": [
      { ... recursive ... }
      ...
    ],
    "Dimensions": {
      "Key": "SERVICE"|"OPERATION"|"USAGE_TYPE"|"REGION"|"FREE_TIER_TYPE"|"DESCRIPTION"|"USAGE_PERCENTAGE",
      "MatchOptions": ["EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL", ...],
      "Values": ["string", ...]
    },
    "Not": { ... recursive ... },
    "Or": [
      { ... recursive ... }
      ...
    ]
  },
  "Or": [
    {
      "And": [
        { ... recursive ... }
        ...
      ],
      "Dimensions": {
        "Key": "SERVICE"|"OPERATION"|"USAGE_TYPE"|"REGION"|"FREE_TIER_TYPE"|"DESCRIPTION"|"USAGE_PERCENTAGE",
        "MatchOptions": ["EQUALS"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL", ...],
        "Values": ["string", ...]
      },
      "Not": { ... recursive ... },
      "Or": [
        { ... recursive ... }
        ...
      ]
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное JSON, так как строка будет воспринята буквально. Это нельзя указывать вместе с --cli-input-yaml.

--starting-token (string)

Токен, чтобы указать, с чего начать разбиение на страницы. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Разбиение на страницы в Руководстве пользователя интерфейса командной строки AWS .

--page-size (integer)

Размер каждой страницы для получения в вызове службы AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.

Примеры использования см. в разделе Разбиение на страницы в Руководстве пользователя интерфейса командной строки AWS .

--max-items (integer)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Чтобы возобновить разбиение на страницы, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

Примеры использования см. в разделе Разбиение на страницы в Руководстве пользователя интерфейса командной строки AWS .

--generate-cli-skeleton (string) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если значение не предоставлено или предоставлено значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и гарантии обратной совместимости в сгенерированном JSON-скелете отсутствуют.

Общие параметры

--debug (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение по умолчанию по проверке SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (string)

Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

freeTierUsages -> (список)

Список объектов использования Free Tier, соответствующих вашему выражению фильтра.

(структура)

Содержит метаданные предложения Amazon Web Services Free Tier и данные вашего использования для предложения.

actualUsageAmount -> (двойное)

Описывает фактическое накопленное использование за текущий месяц (MTD), которым вы уже воспользовались.

description -> (строка)

Описание предложения Free Tier.

forecastedUsageAmount -> (двойное)

Описывает прогнозируемое использование за месяц, которое вы ожидаете использовать.

freeTierType -> (строка)

Описывает тип предложения Free Tier. Например, предложение может быть "12 Months Free" , "Always Free" и "Free Trial" .

limit -> (двойное)

Описывает максимальное разрешенное использование в рамках Free Tier.

operation -> (строка)

Более подробно описывает usageType с помощью конкретной операции API Amazon Web Service. Например, это может быть операция API RunInstances для Amazon Elastic Compute Cloud.

region -> (строка)

Описывает регион Amazon Web Services, для которого это предложение применимо.

service -> (строка)

Название Amazon Web Service, предоставляющего предложение Free Tier. Например, это может быть Amazon Elastic Compute Cloud.

unit -> (строка)

Описывает единицу usageType , такую как Hrs .

usageType -> (строка)

Описывает подробности использования предложения. Например, это может быть Global-BoxUsage:freetrial .

nextToken -> (строка)

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

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

Spec-Zone.ru

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