Spec-Zone.ru › AWS CLI v2

[ aws . s3control ]

put-storage-lens-configuration

Описание

Примечание

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

Устанавливает конфигурацию Amazon S3 Storage Lens. Дополнительную информацию о S3 Storage Lens см. в руководстве пользователя Amazon S3 в разделе Работа с Amazon S3 Storage Lens. Полный список метрик S3 Storage Lens см. в глоссарии метрик S3 Storage Lens в руководстве пользователя Amazon S3.

Примечание

Чтобы использовать эту операцию, необходимо иметь разрешение на выполнение действия s3:PutStorageLensConfiguration. Дополнительную информацию см. в руководстве пользователя Amazon S3 в разделе Установка разрешений для использования Amazon S3 Storage Lens.

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

Синтаксис

  put-storage-lens-configuration
--config-id <value>
--account-id <value>
--storage-lens-configuration <value>
[--tags <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 (строка)

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

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

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

--storage-lens-configuration (структура)

Конфигурация 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 -> (структура)

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

Include -> (список)

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

(строка)

Exclude -> (список)

Указывает, какие ARN групп Storage Lens следует исключать из агрегации групп 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 ``

Синтаксис JSON:

{
  "Id": "string",
  "AccountLevel": {
    "ActivityMetrics": {
      "IsEnabled": true|false
    },
    "BucketLevel": {
      "ActivityMetrics": {
        "IsEnabled": true|false
      },
      "PrefixLevel": {
        "StorageMetrics": {
          "IsEnabled": true|false,
          "SelectionCriteria": {
            "Delimiter": "string",
            "MaxDepth": integer,
            "MinStorageBytesPercentage": double
          }
        }
      },
      "AdvancedCostOptimizationMetrics": {
        "IsEnabled": true|false
      },
      "AdvancedDataProtectionMetrics": {
        "IsEnabled": true|false
      },
      "DetailedStatusCodesMetrics": {
        "IsEnabled": true|false
      }
    },
    "AdvancedCostOptimizationMetrics": {
      "IsEnabled": true|false
    },
    "AdvancedDataProtectionMetrics": {
      "IsEnabled": true|false
    },
    "DetailedStatusCodesMetrics": {
      "IsEnabled": true|false
    },
    "StorageLensGroupLevel": {
      "SelectionCriteria": {
        "Include": ["string", ...],
        "Exclude": ["string", ...]
      }
    }
  },
  "Include": {
    "Buckets": ["string", ...],
    "Regions": ["string", ...]
  },
  "Exclude": {
    "Buckets": ["string", ...],
    "Regions": ["string", ...]
  },
  "DataExport": {
    "S3BucketDestination": {
      "Format": "CSV"|"Parquet",
      "OutputSchemaVersion": "V_1",
      "AccountId": "string",
      "Arn": "string",
      "Prefix": "string",
      "Encryption": {
        "SSES3": {

        },
        "SSEKMS": {
          "KeyId": "string"
        }
      }
    },
    "CloudWatchMetrics": {
      "IsEnabled": true|false
    }
  },
  "IsEnabled": true|false,
  "AwsOrg": {
    "Arn": "string"
  },
  "StorageLensArn": "string"
}

--tags (список)

Набор тегов конфигурации S3 Storage Lens.

Примечание

Можно задать до 50 тегов.

(структура)

Key -> (строка)

Value -> (строка)

Краткая запись синтаксиса:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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 (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.

Вывод

Нет

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

Spec-Zone.ru

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