Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

list-bucket-inventory-configurations

Описание

Примечание

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

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

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

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

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

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

  • GetBucketInventoryConfiguration
  • DeleteBucketInventoryConfiguration
  • PutBucketInventoryConfiguration

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

Синтаксис

  list-bucket-inventory-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 (строка)

Маркер, используемый для продолжения перечисления конфигураций инвентаризации, которая была усечена. Используйте NextContinuationToken из предыдущего усеченного ответа списка для продолжения перечисления. Токен продолжения — это непрозрачное значение, которое понимает Amazon S3.

--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
  • текст
  • таблица
  • 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Примеры

Примечание

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

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

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

Следующий list-bucket-inventory-configurations пример отображает конфигурации инвентаризации для указанного ведра.

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

Вывод:

{
    "InventoryConfigurationList": [
        {
            "IsEnabled": true,
            "Destination": {
                "S3BucketDestination": {
                    "Format": "ORC",
                    "Bucket": "arn:aws:s3:::amzn-s3-demo-bucket",
                    "AccountId": "123456789012"
                }
            },
            "IncludedObjectVersions": "Current",
            "Id": "1",
            "Schedule": {
                "Frequency": "Weekly"
            }
        },
        {
            "IsEnabled": true,
            "Destination": {
                "S3BucketDestination": {
                    "Format": "CSV",
                    "Bucket": "arn:aws:s3:::amzn-s3-demo-bucket",
                    "AccountId": "123456789012"
                }
            },
            "IncludedObjectVersions": "Current",
            "Id": "2",
            "Schedule": {
                "Frequency": "Daily"
            }
        }
    ],
    "IsTruncated": false
}

Вывод

ContinuationToken -> (строка)

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

InventoryConfigurationList -> (список)

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

(структура)

Указывает конфигурацию инвентаризации для ведра Amazon S3. Дополнительную информацию см. в разделе GET Bucket inventory в справочнике Amazon S3 API.

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

Содержит информацию о том, куда публиковать результаты инвентаризации.

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

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

AccountId -> (строка)

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

Примечание

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

Bucket -> (строка)

Идентификатор ресурса Amazon (ARN) ведра, в котором будут опубликованы результаты инвентаризации.

Format -> (строка)

Указывает формат выходных данных инвентаризации.

Prefix -> (строка)

Префикс, добавляемый ко всем результатам инвентаризации.

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

Содержит тип шифрования на стороне сервера, используемого для шифрования результатов инвентаризации.

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

Указывает использование SSE-S3 для шифрования отчетов об инвентаризации.

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

Указывает использование SSE-KMS для шифрования отчетов об инвентаризации.

KeyId -> (строка)

Указывает идентификатор симметричного ключа шифрования KMS для управляемого пользователем ключа для шифрования отчетов об инвентаризации.

IsEnabled -> (логическое значение)

Указывает, включена ли инвентаризация или отключена. Если установлено True, генерируется список инвентаризации. Если установлено False, список инвентаризации не генерируется.

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

Указывает фильтр инвентаризации. Инвентаризация включает только объекты, соответствующие критериям фильтра.

Prefix -> (строка)

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

Id -> (строка)

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

IncludedObjectVersions -> (строка)

Версии объектов, которые необходимо включить в список инвентаризации. Если установлено All, список включает все версии объектов, что добавляет поля, связанные с версиями, VersionId, IsLatest и DeleteMarker, в список. Если установлено Current, этот список не содержит этих полей, связанных с версиями.

OptionalFields -> (список)

Содержит дополнительные поля, включенные в результаты инвентаризации.

(строка)

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

Указывает расписание для генерации результатов инвентаризации.

Frequency -> (строка)

Указывает периодичность генерации результатов инвентаризации.

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

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

NextContinuationToken -> (строка)

Маркер для продолжения перечисления конфигураций инвентаризации. Используйте NextContinuationToken из этого ответа для продолжения перечисления в последующем запросе. Токен продолжения — это непрозрачное значение, которое понимает Amazon S3.

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

Spec-Zone.ru

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