[ aws . storagegateway ]
describe-cache-report
Описание
Возвращает информацию о заданном отчёте кэша, включая статус завершения и прогресс генерации.
См. также: Документация AWS API
Синтаксис
describe-cache-report
--cache-report-arn <value>
[--cli-input-json | --cli-input-yaml]
[--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]
Параметры
--cache-report-arn (строка)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--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 (строка)
Пакет сертификатов 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.
Вывод
CacheReportInfo -> (структура)
Содержит все информационные поля, связанные с отчётом кэша. Включает имя, ARN, теги, статус, прогресс, фильтры, время начала и завершения.
CacheReportARN -> (строка)
CacheReportStatus -> (строка)
ReportCompletionPercent -> (целое число)
EndTime -> (временная метка)
Role -> (строка)
FileShareARN -> (строка)
LocationARN -> (строка)
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 -> (строка)
Tags -> (список)
Список пар ключ/значение тегов, связанных с отчётом.
(структура)
Пара ключ-значение, которая помогает управлять, фильтровать и искать ваши ресурсы. Допустимые символы: буквы, пробелы и цифры, представимые в UTF-8, а также следующие символы: + - = . _ : /.
Key -> (строка)
Value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.