Spec-Zone.ru › AWS CLI v2

[ aws . macie2 ]

get-usage-statistics

Описание

Получает (запрашивает) квоты и агрегированные данные об использовании для одного или нескольких аккаунтов.

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

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

Синтаксис

  get-usage-statistics
[--filter-by <value>]
[--sort-by <value>]
[--time-range <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]

Параметры

--filter-by (список)

Массив объектов, по одному для каждого условия фильтрации результатов запроса. Если вы укажете более одного условия, Amazon Macie использует оператор AND для объединения условий.

(структура)

Указывает условие для фильтрации результатов запроса квот и данных об использовании для одного или нескольких аккаунтов Amazon Macie.

comparator -> (строка)

Оператор, используемый в условии. Если значение для свойства key равно accountId, это значение должно быть CONTAINS. Если значение для свойства key — любое другое поддерживаемое поле, это значение может быть EQ, GT, GTE, LT, LTE или NE.

key -> (строка)

Поле, используемое в условии.

values -> (список)

Массив, перечисляющий значения, используемые в условии, на основе значения для поля, указанного свойством key. Если значение для свойства key равно accountId, этот массив может указывать несколько значений. В противном случае этот массив может указывать только одно значение.

Допустимые значения для каждого поддерживаемого поля:

  • accountId - Уникальный идентификатор аккаунта Amazon Web Services.
  • freeTrialStartDate - Дата и время начала бесплатного пробного периода Amazon Macie для аккаунта в формате UTC и расширенного ISO 8601.
  • serviceLimit - Логическое значение (true или false), указывающее, достиг ли аккаунт своей ежемесячной квоты.
  • total - Строка, представляющая текущую оцененную стоимость для аккаунта.

(строка)

Сокращенный синтаксис:

comparator=string,key=string,values=string,string ...

Синтаксис JSON:

[
  {
    "comparator": "GT"|"GTE"|"LT"|"LTE"|"EQ"|"NE"|"CONTAINS",
    "key": "accountId"|"serviceLimit"|"freeTrialStartDate"|"total",
    "values": ["string", ...]
  }
  ...
]

--sort-by (структура)

Критерии для сортировки результатов запроса.

key -> (строка)

Поле для сортировки результатов.

orderBy -> (строка)

Порядок сортировки результатов, основанный на значении для поля, указанного свойством key. Допустимые значения: ASC, для сортировки результатов в порядке возрастания; и DESC, для сортировки результатов в порядке убывания.

Сокращенный синтаксис:

key=string,orderBy=string

Синтаксис JSON:

{
  "key": "accountId"|"total"|"serviceLimitValue"|"freeTrialStartDate",
  "orderBy": "ASC"|"DESC"
}

--time-range (строка)

Включенный временной интервал для запроса данных об использовании. Допустимые значения: MONTH_TO_DATE, для текущего календарного месяца по текущую дату; и PAST_30_DAYS, для предыдущих 30 дней. Если вы не укажете значение, Amazon Macie предоставит данные об использовании за предыдущие 30 дней.

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

  • MONTH_TO_DATE
  • PAST_30_DAYS

--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
  • текст
  • таблица
  • 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.

Вывод

nextToken -> (строка)

Строка, используемая в последующем запросе для получения следующей страницы результатов в постраничном ответе. Это значение равно null, если дополнительных страниц нет.

records -> (список)

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

(структура)

Предоставляет квоту и агрегированные данные использования для учетной записи Amazon Macie.

accountId -> (строка)

Уникальный идентификатор учетной записи Amazon Web Services, к которой относятся данные.

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

Дата и время (UTC в расширенном формате ISO 8601), когда для учетной записи начался бесплатный период пробного использования автоматического обнаружения конфиденциальных данных. Это значение равно null, если для учетной записи не включено автоматическое обнаружение конфиденциальных данных.

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

Дата и время (UTC в расширенном формате ISO 8601), когда для учетной записи начался бесплатный период пробного использования Amazon Macie.

usage -> (список)

Массив объектов, содержащих данные использования и квоты для учетной записи. Каждый объект содержит данные для определенного показателя использования и соответствующей квоты.

(структура)

Предоставляет данные для определенного показателя использования и соответствующей квоты для учетной записи Amazon Macie.

currency -> (строка)

Тип валюты, в которой отображается значение показателя (estimatedCost).

estimatedCost -> (строка)

Оцененное значение показателя.

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

Текущее значение квоты, соответствующей показателю, указанному в поле type.

isServiceLimited -> (булево)

Указывает, достигла ли учетная запись квоту, соответствующую показателю, указанному в поле UsageByAccount.type в ответе.

unit -> (строка)

Единица измерения значения, указанного в поле value.

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

Значение показателя, указанного в поле UsageByAccount.type в ответе.

type -> (строка)

Название показателя. Возможные значения: AUTOMATED_OBJECT_MONITORING (для мониторинга объектов S3 в отношении автоматического обнаружения конфиденциальных данных); AUTOMATED_SENSITIVE_DATA_DISCOVERY (для анализа объектов S3 в отношении автоматического обнаружения конфиденциальных данных); DATA_INVENTORY_EVALUATION (для мониторинга ведер S3); и SENSITIVE_DATA_DISCOVERY (для выполнения задач классификации).

timeRange -> (строка)

Включительно период времени, к которому относятся данные об использовании. Возможные значения: MONTH_TO_DATE (для текущего календарного месяца); и PAST_30_DAYS (для предыдущих 30 дней).

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

Spec-Zone.ru

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