Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

get-bucket-inventory-configuration

Описание

Примечание

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

Возвращает конфигурацию инвентаризации (идентифицируемую по идентификатору конфигурации инвентаризации) из ведра.

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

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

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

  • DeleteBucketInventoryConfiguration
  • ListBucketInventoryConfigurations
  • PutBucketInventoryConfiguration

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

Синтаксис

  get-bucket-inventory-configuration
--bucket <value>
--id <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 (строка)

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

--id (строка)

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

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

Примеры

Примечание

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

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

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

Следующий get-bucket-inventory-configuration пример получает конфигурацию инвентаризации для указанного ведра с идентификатором 1.

aws s3api get-bucket-inventory-configuration \
    --bucket amzn-s3-demo-bucket \
    --id 1

Вывод:

{
    "InventoryConfiguration": {
        "IsEnabled": true,
        "Destination": {
            "S3BucketDestination": {
                "Format": "ORC",
                "Bucket": "arn:aws:s3:::amzn-s3-demo-bucket",
                "AccountId": "123456789012"
            }
        },
        "IncludedObjectVersions": "Current",
        "Id": "1",
        "Schedule": {
            "Frequency": "Weekly"
        }
    }
}

Вывод

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

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

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

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

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

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

AccountId -> (строка)

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

Примечание

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

Bucket -> (строка)

Amazon Resource Name (ARN) ведра, где будут опубликованы результаты инвентаризации.

Format -> (строка)

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

Prefix -> (строка)

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

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

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

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

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

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

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

KeyId -> (строка)

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

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

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

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

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

Prefix -> (строка)

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

Id -> (строка)

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

IncludedObjectVersions -> (строка)

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

OptionalFields -> (список)

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

(строка)

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

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

Frequency -> (строка)

Определяет частоту создания результатов инвентаризации.

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

Spec-Zone.ru

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