Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

list-bucket-analytics-configurations

Описание

Примечание

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

Перечисляет конфигурации аналитики для ведра. Вы можете иметь до 1000 конфигураций аналитики на ведро.

Этот action поддерживает постраничную навигацию по списку и не возвращает более 100 конфигураций за раз. Вы всегда должны проверять элемент IsTruncated в ответе. Если больше конфигураций для перечисления нет, IsTruncated устанавливается в значение false. Если есть больше конфигураций для перечисления, IsTruncated устанавливается в значение true, и будет значение в NextContinuationToken . Вы используете значение NextContinuationToken для продолжения постраничной навигации по списку, передавая значение в continuation-token в запросе к GET следующей странице.

Для использования этой операции у вас должны быть разрешения на выполнение действия s3:GetAnalyticsConfiguration. Владелец ведра имеет это разрешение по умолчанию. Владелец ведра может предоставить это разрешение другим. Дополнительную информацию о разрешениях см. в разделе Разрешения, связанные с операциями над подресурсами ведра, и Управление разрешениями доступа к вашим ресурсам Amazon S3.

Дополнительную информацию об аналитике Amazon S3 см. в разделе Amazon S3 Analytics – Анализ классов хранения.

Следующие операции связаны с ListBucketAnalyticsConfigurations:

  • GetBucketAnalyticsConfiguration
  • DeleteBucketAnalyticsConfiguration
  • PutBucketAnalyticsConfiguration

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

Синтаксис

  list-bucket-analytics-configurations
--bucket <value>
[--continuation-token <value>]
[--expected-bucket-owner <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]

Параметры

--bucket (строка)

Имя ведра, из которого извлекаются конфигурации аналитики.

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

ContinuationToken, представляющий собой заполнитель, с которого следует начать этот запрос.

--expected-bucket-owner (строка)

Идентификатор учетной записи владельца ожидаемого ведра. Если предоставленный вами идентификатор учетной записи не совпадает с фактическим владельцем ведра, запрос завершается с кодом состояния HTTP 403 Forbidden (доступ запрещен).

--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
  • таблица
  • 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-auto-prompt (логическое)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры имеют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.

Для получения списка конфигураций аналитики для ведра

Следующий list-bucket-analytics-configurations получает список конфигураций аналитики для указанного ведра.

aws s3api list-bucket-analytics-configurations \
    --bucket amzn-s3-demo-bucket

Вывод:

{
    "AnalyticsConfigurationList": [
        {
            "StorageClassAnalysis": {},
            "Id": "1"
        }
    ],
    "IsTruncated": false
}

Вывод

IsTruncated -> (логическое)

Указывает, является ли возвращенный список конфигураций аналитики полным. Значение true указывает, что список неполный, и для последующего запроса будет предоставлен NextContinuationToken.

ContinuationToken -> (строка)

Маркер, используемый в качестве точки начала ответа на этот список конфигураций аналитики. Это значение присутствует, если оно было отправлено в запросе.

NextContinuationToken -> (строка)

NextContinuationToken отправляется, когда isTruncated равно true, что указывает на наличие дополнительных конфигураций аналитики для перечисления. Следующий запрос должен включать этот NextContinuationToken . Токен замаскирован и не является пригодным значением.

AnalyticsConfigurationList -> (список)

Список конфигураций аналитики для ведра.

(структура)

Определяет конфигурацию и любые анализы для фильтра аналитики ведра Amazon S3.

Id -> (строка)

Идентификатор, определяющий конфигурацию аналитики.

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

Фильтр, используемый для описания набора объектов для анализа. Фильтр должен содержать ровно один префикс, одну метку или одно сопряжение (AnalyticsAndOperator). Если фильтр не предоставлен, все объекты будут рассматриваться при любом анализе.

Prefix -> (строка)

Префикс для использования при оценке фильтра аналитики.

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

Метка для использования при оценке фильтра аналитики.

Key -> (строка)

Имя ключа объекта.

Value -> (строка)

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

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

Сопряжение (логическое И) предикатов, используемых при оценке фильтра аналитики. Оператор должен иметь как минимум два предиката.

Prefix -> (строка)

Префикс для использования при оценке предиката И: Префикс, который должен иметь объект, чтобы он был включен в результаты метрик.

Tags -> (список)

Список меток для использования при оценке предиката И.

(структура)

Контейнер пары имени значения ключа.

Key -> (строка)

Имя ключа объекта.

Value -> (строка)

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

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

Содержит данные, относящиеся к паттернам доступа, которые должны быть собраны и доступны для анализа компромиссов между различными классами хранения.

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

Указывает, как должны экспортироваться данные, относящиеся к анализу класса хранения для ведра Amazon S3.

OutputSchemaVersion -> (строка)

Версия схемы вывода для использования при экспорте данных. Должна быть V_1 .

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

Место для хранения данных для анализа.

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

Назначение, указывающее на вывод в ведро S3.

Format -> (строка)

Указывает формат файла, используемый при экспорте данных в Amazon S3.

BucketAccountId -> (строка)

Идентификатор учетной записи владельца целевого ведра S3. Если идентификатор учетной записи не предоставлен, владелец не проверяется перед экспортом данных.

Примечание

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

Bucket -> (строка)

Amazon Resource Name (ARN) ведра, в которое экспортируются данные.

Prefix -> (строка)

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

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

Spec-Zone.ru

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