Spec-Zone.ru › AWS CLI v2

[ aws . s3control ]

получение конфигурации Storage Lens

Описание

Примечание

Данная операция не поддерживается для ведер каталогов.

Получает конфигурацию Amazon S3 Storage Lens. Дополнительную информацию см. в разделе «Оценивание активности и использования хранилища с помощью Amazon S3 Storage Lens» в руководстве пользователя Amazon S3. Полный список метрик S3 Storage Lens см. в глоссарии метрик S3 Storage Lens в руководстве пользователя Amazon S3.

Примечание

Для использования этого действия необходимо иметь разрешение на выполнение действия s3:GetStorageLensConfiguration. Дополнительную информацию см. в разделе «Настройка разрешений для использования Amazon S3 Storage Lens» в руководстве пользователя Amazon S3.

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

Синтаксис

  get-storage-lens-configuration
--config-id <value>
--account-id <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]

Параметры

--config-id (строка)

Идентификатор конфигурации Amazon S3 Storage Lens.

--account-id (строка)

Идентификатор учетной записи запрашивающего.

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

Вывод

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

Запрошенная конфигурация S3 Storage Lens.

Id -> (строка)

Контейнер для идентификатора конфигурации Amazon S3 Storage Lens.

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

Контейнер для всех конфигураций уровня учетной записи вашей конфигурации S3 Storage Lens.

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

Контейнер для метрик активности S3 Storage Lens.

IsEnabled -> (булево)

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

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

Контейнер для конфигурации S3 Storage Lens на уровне ведра.

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

Контейнер для метрик активности на уровне ведра для S3 Storage Lens.

IsEnabled -> (булево)

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

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

Контейнер для метрик на уровне префикса для S3 Storage Lens.

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

Контейнер для метрик хранения на уровне префикса для S3 Storage Lens.

IsEnabled -> (булево)

Контейнер для того, включены ли метрики хранения на уровне префикса.

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

Delimiter -> (строка)

Контейнер для разделителя используемых критериев выбора.

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

Максимальная глубина критериев выбора.

MinStorageBytesPercentage -> (вещественное число)

Минимальный процент хранилища байтов, метрики которых будут выбраны.

Примечание

Вы должны выбрать значение, большее или равное 1.0 .

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

Контейнер для расширенных метрик оптимизации затрат на уровне ведра для S3 Storage Lens.

IsEnabled -> (булево)

Контейнер, указывающий, включены ли расширенные метрики оптимизации затрат.

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

Контейнер для расширенных метрик защиты данных на уровне ведра для S3 Storage Lens.

IsEnabled -> (булево)

Контейнер, указывающий, включены ли расширенные метрики защиты данных.

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

Контейнер для подробных метрик кодов состояния на уровне ведра для S3 Storage Lens.

IsEnabled -> (булево)

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

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

Контейнер для расширенных метрик оптимизации затрат S3 Storage Lens.

IsEnabled -> (булево)

Контейнер, указывающий, включены ли расширенные метрики оптимизации затрат.

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

Контейнер для расширенных метрик защиты данных S3 Storage Lens.

IsEnabled -> (булево)

Контейнер, указывающий, включены ли расширенные метрики защиты данных.

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

Контейнер для подробных метрик кодов состояния.

IsEnabled -> (булево)

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

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

Контейнер для метрик групп S3 Storage Lens.

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

Указывает, какие ARNs групп S3 Storage Lens следует включать или исключать в агрегации групп S3 Storage Lens. Если это значение оставлено нулевым, все группы S3 Storage Lens выбираются.

Include -> (список)

Указывает, какие ARNs групп S3 Storage Lens следует включать в агрегацию групп S3 Storage Lens.

(строка)

Exclude -> (список)

Указывает, какие ARNs групп S3 Storage Lens следует исключить из агрегации групп S3 Storage Lens.

(строка)

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

Контейнер для включенного в эту конфигурацию. Этот контейнер может быть допустим только в том случае, если нет Exclude контейнера, предоставленного, и он не пуст.

Buckets -> (список)

Контейнер для включенных ведер S3 Storage Lens.

(строка)

Regions -> (список)

Контейнер для включенных регионов S3 Storage Lens.

(строка)

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

Контейнер для исключенного в этой конфигурации. Этот контейнер может быть допустим только в том случае, если нет Include контейнера, предоставленного, и он не пуст.

Buckets -> (список)

Контейнер для исключенных ведер S3 Storage Lens.

(строка)

Regions -> (список)

Контейнер для исключенных регионов S3 Storage Lens.

(строка)

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

Контейнер для указания свойств экспорта метрик S3 Storage Lens, включая место назначения, схему и формат.

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

Контейнер для ведра, где будет расположен экспорт метрик S3 Storage Lens.

Примечание

Это ведро должно находиться в том же регионе, что и конфигурация хранилища.

Format -> (строка)

OutputSchemaVersion -> (строка)

Версия схемы файла экспорта.

AccountId -> (строка)

Идентификатор учетной записи владельца ведра экспорта метрик S3 Storage Lens.

Arn -> (строка)

Amazon Resource Name (ARN) ведра. Это свойство является только для чтения и соответствует следующему формату: ``arn:aws:s3:us-east-1 :example-account-id :bucket/your-destination-bucket-name ``

Prefix -> (строка)

Префикс целевого ведра, куда будут передаваться метрики.

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

Контейнер для типа шифрования экспорта метрик в этом ведре.

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

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

KeyId -> (строка)

Контейнер для ARN шифрования SSE-KMS. Это свойство является только для чтения и соответствует следующему формату: ``arn:aws:kms:us-east-1 :example-account-id :key/example-9a73-4afc-8d29-8f5900cef44e ``

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

Контейнер для включения публикации в Amazon CloudWatch для метрик S3 Storage Lens.

IsEnabled -> (булево)

Контейнер, указывающий, включена ли публикация в CloudWatch для метрик S3 Storage Lens. Значение true указывает, что публикация в CloudWatch для метрик S3 Storage Lens включена.

IsEnabled -> (булево)

Контейнер для того, включена ли конфигурация S3 Storage Lens.

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

Контейнер для организации Amazon Web Services для этой конфигурации S3 Storage Lens.

Arn -> (строка)

Контейнер для Amazon Resource Name (ARN) организации Amazon Web Services. Это свойство является только для чтения и соответствует следующему формату: ``arn:aws:organizations:us-east-1 :example-account-id :organization/o-ex2l495dck ``

StorageLensArn -> (строка)

Amazon Resource Name (ARN) конфигурации S3 Storage Lens. Это свойство является только для чтения и соответствует следующему формату: ``arn:aws:s3:us-east-1 :example-account-id :storage-lens/your-dashboard-name ``

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

Spec-Zone.ru

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