Spec-Zone.ru › AWS CLI v2

[ aws . storagegateway ]

list-cache-reports

Описание

Возвращает список существующих отчётов кэша для всех файловых ресурсов, связанных с вашей учётной записью Amazon Web Services. Этот список включает всю информацию, предоставляемую действием DescribeCacheReport, такую как имя отчёта, статус, процент завершения, время начала, время окончания, фильтры и метки.

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

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

Синтаксис

  list-cache-reports
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

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

--starting-token (строка)

Маркер для указания начальной точки постраничной обработки. Это значение NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя 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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (логическое значение)

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

--ca-bundle (строка)

Файл с сертификатом корневого центра сертификации для проверки 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.

Вывод

CacheReportList -> (список)

Список существующих отчетов кэширования для всех файловых ресурсов, связанных с вашей учётной записью Amazon Web Services. Этот список включает всю информацию, предоставленную действием DescribeCacheReport, такую как статус отчёта, процент завершения, время начала, время окончания, фильтры и метки.

(структура)

Содержит все информационные поля, связанные с отчётом кэширования. Включает имя, ARN, метки, статус, прогресс, фильтры, время начала и время окончания.

CacheReportARN -> (строка)

Amazon Resource Name (ARN) отчета кэширования, который вы хотите описать.

CacheReportStatus -> (строка)

Статус указанного отчёта кэширования.

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

Процент процесса генерации отчёта, завершённый на момент запроса.

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

Время, в которое шлюз прекратил генерацию отчёта кэширования.

Role -> (строка)

ARN роли IAM, которую шлюз S3 File принимает при доступе к основному хранилищу.

FileShareARN -> (строка)

Amazon Resource Name (ARN) файлового ресурса.

LocationARN -> (строка)

ARN расположения Amazon S3, где сохранен отчет кэширования.

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

Время, в которое шлюз начал генерацию отчёта кэширования.

InclusionFilters -> (список)

Список фильтров и параметров, определяющих, какие файлы включаются в отчет.

(структура)

Список параметров фильтра и соответствующих значений, определяющих, какие файлы включаются или исключаются из отчета кэширования, созданного запросом StartCacheReport. Несколько экземпляров одного и того же параметра фильтра объединяются операцией ИЛИ, а разные параметры — операцией И.

Name -> (строка)

Имя параметра фильтра, определяющего, какие файлы включаются или исключаются из отчёта кэширования.

Допустимые имена:

UploadFailureReason | UploadState

Values -> (список)

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

Допустимые значения ``UploadFailureReason``:

InaccessibleStorageClass | InvalidObjectState | ObjectMissing | S3AccessDenied

Допустимые значения ``UploadState``:

FailingUpload

(строка)

ExclusionFilters -> (список)

Список фильтров и параметров, определяющих, какие файлы исключаются из отчёта.

(структура)

Список параметров фильтра и соответствующих значений, определяющих, какие файлы включаются или исключаются из отчёта кэширования, созданного запросом StartCacheReport. Несколько экземпляров одного и того же параметра фильтра объединяются операцией ИЛИ, а разные параметры — операцией И.

Name -> (строка)

Имя параметра фильтра, определяющего, какие файлы включаются или исключаются из отчёта кэширования.

Допустимые имена:

UploadFailureReason | UploadState

Values -> (список)

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

Допустимые значения ``UploadFailureReason``:

InaccessibleStorageClass | InvalidObjectState | ObjectMissing | S3AccessDenied

Допустимые значения ``UploadState``:

FailingUpload

(строка)

ReportName -> (строка)

Имя файла завершённого отчёта кэширования, хранящегося в Amazon S3.

Tags -> (список)

Список пар "ключ-значение" меток, связанных с отчётом.

(структура)

Пара "ключ-значение", которая помогает управлять, фильтровать и искать ваши ресурсы. Допустимые символы: буквы, пробелы и цифры, представимые в UTF-8, а также следующие символы: + - = . _ : /.

Key -> (строка)

Ключ метки. Ключ не может начинаться с aws:.

Value -> (строка)

Значение ключа метки.

Marker -> (строка)

Если запрос включает Marker, ответ возвращает это значение в этом поле.

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

Spec-Zone.ru

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