object-exists

Описание

Ожидание получения ответа 200 при опросе с помощью head-object. Будет выполняться опрос каждые 5 секунд до достижения успешного состояния. Этот процесс завершится с кодом возврата 255 после 20 неудачных проверок.

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

Синтаксис

  object-exists
--bucket <value>
[--if-match <value>]
[--if-modified-since <value>]
[--if-none-match <value>]
[--if-unmodified-since <value>]
--key <value>
[--range <value>]
[--response-cache-control <value>]
[--response-content-disposition <value>]
[--response-content-encoding <value>]
[--response-content-language <value>]
[--response-content-type <value>]
[--response-expires <value>]
[--version-id <value>]
[--sse-customer-algorithm <value>]
[--sse-customer-key <value>]
[--sse-customer-key-md5 <value>]
[--request-payer <value>]
[--part-number <value>]
[--expected-bucket-owner <value>]
[--checksum-mode <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 (строка)

Имя ведра, содержащего объект.

Ведра каталогов - При использовании этой операции с ведром каталогов необходимо использовать запросы в стиле виртуального хостинга в формате `` Имя-ведра .s3express-идентификатор-зоны .*код-региона* .amazonaws.com`` . Запросы в стиле пути не поддерживаются. Имена ведер каталогов должны быть уникальными в выбранной зоне (зоне доступности или локальной зоне). Имена ведер должны соответствовать формату `` базовое-имя-ведра –идентификатор-зоны –x-s3`` (например, `` amzn-s3-demo-bucket –usw2-az1 –x-s3`` ). Сведения о ограничениях именования ведер см. в руководстве пользователя Amazon S3.

Точки доступа - При использовании этого действия с точкой доступа для ведер общего назначения необходимо указать псевдоним точки доступа вместо имени ведра или указать ARN точки доступа. При использовании этого действия с точкой доступа для ведер каталогов необходимо указать имя точки доступа вместо имени ведра. При использовании ARN точки доступа запросы должны быть направлены на хост-имя точки доступа. Хост-имя точки доступа имеет вид ИмяТочкиДоступа -ИдентификаторАккаунта .s3-accesspoint.*Регион* .amazonaws.com. При использовании этого действия с точкой доступа через SDK Amazon Web Services необходимо указать ARN точки доступа вместо имени ведра. Дополнительные сведения об ARN точек доступа см. в руководстве пользователя Amazon S3.

Примечание

Точки доступа Object Lambda не поддерживаются ведрами каталогов.

S3 в Outposts - При использовании этого действия с S3 в Outposts необходимо направить запросы на хост-имя S3 в Outposts. Хост-имя S3 в Outposts имеет вид `` ИмяТочкиДоступа -ИдентификаторАккаунта .*идентификатор-outpost* .s3-outposts.*Регион* .amazonaws.com`` . При использовании этого действия с S3 в Outposts конечное ведро должно быть ARN точки доступа Outposts или псевдонимом точки доступа. Дополнительные сведения о S3 в Outposts см. в руководстве пользователя Amazon S3.

--if-match (строка)

Возвращает объект только в том случае, если его тег сущности (ETag) совпадает с указанным; в противном случае возвращается ошибка 412 (предусловие не выполнено).

Если оба заголовка If-Match и If-Unmodified-Since присутствуют в запросе следующим образом:

условие If-Match вычисляется как true , и;
условие If-Unmodified-Since вычисляется как false ;

Тогда Amazon S3 возвращает 200 OK и запрашиваемые данные.

Дополнительную информацию об условных запросах см. в RFC 7232.

--if-modified-since (метка времени)

Возвращает объект только в том случае, если он был изменен после указанного времени; в противном случае возвращается ошибка 304 (не изменено).

Если оба заголовка If-None-Match и If-Modified-Since присутствуют в запросе следующим образом:

условие If-None-Match вычисляется как false , и;
условие If-Modified-Since вычисляется как true ;

Тогда Amazon S3 возвращает ответный код 304 Not Modified.

Дополнительную информацию об условных запросах см. в RFC 7232.

--if-none-match (строка)

Возвращает объект только в том случае, если его тег сущности (ETag) отличается от указанного; в противном случае возвращается ошибка 304 (не изменено).

Если оба заголовка If-None-Match и If-Modified-Since присутствуют в запросе следующим образом:

условие If-None-Match вычисляется как false , и;
условие If-Modified-Since вычисляется как true ;

Тогда Amazon S3 возвращает код ответа 304 Not Modified.

Дополнительную информацию об условных запросах см. в RFC 7232.

--if-unmodified-since (метка времени)

Возвращает объект только в том случае, если он не был изменен после указанного времени; в противном случае возвращается ошибка 412 (предусловие не выполнено).

Если оба заголовка If-Match и If-Unmodified-Since присутствуют в запросе следующим образом:

условие If-Match вычисляется как true , и;
условие If-Unmodified-Since вычисляется как false ;

Тогда Amazon S3 возвращает 200 OK и запрашиваемые данные.

Дополнительную информацию об условных запросах см. в RFC 7232.

--key (строка)

Ключ объекта.

--range (строка)

HeadObject возвращает только метаданные объекта. Если диапазон удовлетворяет запросу, только ContentLength затронут в ответе. Если диапазон не удовлетворяет запросу, S3 возвращает ошибку 416 - Requested Range Not Satisfiable.

--response-cache-control (строка)

Устанавливает заголовок Cache-Control ответа.

--response-content-disposition (строка)

Устанавливает заголовок Content-Disposition ответа.

--response-content-encoding (строка)

Устанавливает заголовок Content-Encoding ответа.

--response-content-language (строка)

Устанавливает заголовок Content-Language ответа.

--response-content-type (строка)

Устанавливает заголовок Content-Type ответа.

--response-expires (метка времени)

Устанавливает заголовок Expires ответа.

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

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

Примечание

Для ведер каталогов в этой операции API поддерживается только значение null идентификатора версии.

--sse-customer-algorithm (строка)

Указывает алгоритм, используемый при шифровании объекта (например, AES256).

Примечание

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

--sse-customer-key (строка)

Указывает предоставленный клиентом ключ шифрования для Amazon S3, используемый для шифрования данных. Это значение используется для хранения объекта, а затем удаляется; Amazon S3 не хранит ключ шифрования. Ключ должен быть подходящим для использования с алгоритмом, указанным в заголовке x-amz-server-side-encryption-customer-algorithm.

Примечание

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

--sse-customer-key-md5 (строка)

Указывает 128-битный MD5-дайджест ключа шифрования в соответствии с RFC 1321. Amazon S3 использует этот заголовок для проверки целостности сообщения, чтобы гарантировать, что ключ шифрования был передан без ошибок.

Примечание

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

--request-payer (строка)

Подтверждает, что запрашивающий знает, что он будет оплачивать за запрос. Владельцам ведер не нужно указывать этот параметр в своих запросах. Если в источнике или в конечном ведре S3 включен платный запрос, запрашивающий будет оплачивать соответствующие расходы на копирование объекта. Дополнительные сведения о загрузке объектов из ведер с платой за запрос см. в руководстве пользователя Amazon S3.

Примечание

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

Возможные значения:

requester

--part-number (целое число)

Номер части объекта, подлежащей чтению. Это целое число от 1 до 10 000. Эффективно выполняет запрос HEAD с диапазоном для указанной части. Полезно для запроса размера части и количества частей в этом объекте.

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

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

--checksum-mode (строка)

Для получения контрольной суммы этот параметр должен быть включен.

Ведра общего назначения - Если вы включили режим контрольной суммы, а объект загружен с контрольной суммой и зашифрован ключом службы управления ключами (KMS), вам необходимо иметь разрешение на использование действия kms:Decrypt для получения контрольной суммы.

Ведра каталогов - Если вы включили ChecksumMode, а объект зашифрован с помощью службы управления ключами Amazon Web Services (Amazon Web Services KMS), вам также необходимо иметь разрешения kms:GenerateDataKey и kms:Decrypt в политиках IAM на основе учетных данных и политиках ключа KMS для ключа KMS, чтобы получить контрольную сумму объекта.

Возможные значения:

ENABLED

--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-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Для ожидания (паузы выполнения) до существования объекта

Следующий wait object-not-exists пример приостанавливается и продолжает работу только после подтверждения существования указанного объекта (--key) в указанном ведре.

aws s3api wait object-exists \
    --bucket amzn-s3-demo-bucket \
    --key doc1.rtf

Эта команда не выводит ничего на экран.

Вывод

Ничего