head-object

Описание

Операция HEAD извлекает метаданные объекта, не возвращая сам объект. Эта операция полезна, если вас интересуют только метаданные объекта.

Заголовки запроса ограничены по размеру 8 КБ. Для получения дополнительной информации см. Общие заголовки запроса.

• Разрешения на ведро общего назначения - Чтобы использовать HEAD, необходимо разрешение s3:GetObject. Вам также потребуется соответствующее разрешение на чтение объекта (или версии) для этой операции. Дополнительную информацию см. в разделе Действия, ресурсы и ключи условий для Amazon S3 в руководстве пользователя Amazon S3. Более подробную информацию о разрешениях на операции API S3 по типам ресурсов S3 см. в Требуемые разрешения для операций API Amazon S3 в руководстве пользователя Amazon S3. Если запрашиваемый вами объект не существует, ошибка, возвращаемая Amazon S3, зависит от того, есть ли у вас также разрешение s3:ListBucket.

  • Если у вас есть разрешение s3:ListBucket на ведро, Amazon S3 возвращает ошибку с кодом HTTP 404 Not Found.
  • Если у вас нет разрешения s3:ListBucket, Amazon S3 возвращает ошибку с кодом HTTP 403 Forbidden.

• Разрешения на ведро каталога - Для предоставления доступа к этой операции API для ведра каталога рекомендуется использовать операцию API ` CreateSession https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html`__ для сессионно-ориентированной авторизации. Конкретно, вы предоставляете разрешение s3express:CreateSession на ведро каталога в политике ведра или политике, основанной на идентификаторе IAM. Затем вы выполняете вызов API CreateSession на ведре для получения токена сессии. С токеном сессии в заголовке запроса вы можете выполнять запросы API к этой операции. После истечения срока действия токена сессии вы выполняете ещё один вызов API CreateSession для генерации нового токена сессии. Amazon Web Services CLI или SDK автоматически создают сессию и обновляют токен сессии, чтобы избежать прерывания службы при истечении срока действия сессии. Дополнительную информацию об авторизации см. в ` CreateSession https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html`__ . Если вы включите x-amz-checksum-mode в запросе, а объект зашифрован с помощью Amazon Web Services Key Management Service (Amazon Web Services KMS), вам также необходимо иметь разрешения kms:GenerateDataKey и kms:Decrypt в политиках, основанных на идентификаторах IAM, и политиках ключа KMS для ключа KMS, чтобы получить контрольную сумму объекта.

  Шифрование

Если вы шифруете объект с использованием шифрования на стороне сервера с предоставленными клиентом ключами (SSE-C) при хранении объекта в Amazon S3, при извлечении метаданных из объекта необходимо использовать следующие заголовки для предоставления ключа шифрования серверу, чтобы он мог извлечь метаданные объекта. Заголовки:

• x-amz-server-side-encryption-customer-algorithm
• x-amz-server-side-encryption-customer-key
• x-amz-server-side-encryption-customer-key-MD5

Дополнительную информацию о SSE-C см. в разделе Шифрование на стороне сервера (использование ключей шифрования, предоставленных клиентом) в руководстве пользователя Amazon S3.

• Если текущая версия объекта является маркером удаления, Amazon S3 ведёт себя так, как будто объект был удалён, и включает x-amz-delete-marker: true в ответ.
• Если указанная версия является маркером удаления, ответ возвращает ошибку 405 Method Not Allowed и заголовок ответа Last-Modified: timestamp.

Следующие действия связаны с HeadObject :

• GetObject
• GetObjectAttributes

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

Синтаксис

  head-object
--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 (строка)

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

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

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

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

--key (строка)

--range (строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Примеры

Следующая команда извлекает метаданные для объекта в ведре с именем amzn-s3-demo-bucket:

aws s3api head-object --bucket amzn-s3-demo-bucket --key index.html

Вывод:

{
    "AcceptRanges": "bytes",
    "ContentType": "text/html",
    "LastModified": "Thu, 16 Apr 2015 18:19:14 GMT",
    "ContentLength": 77,
    "VersionId": "null",
    "ETag": "\"30a6ec7e1a9ad79c203d05a589c8b400\"",
    "Metadata": {}
}

Вывод

DeleteMarker -> (boolean)

AcceptRanges -> (строка)

Expiration -> (строка)

Restore -> (строка)

ArchiveStatus -> (строка)

LastModified -> (метка времени)

ContentLength -> (длинное целое число)

ChecksumCRC32 -> (строка)

ChecksumCRC32C -> (строка)

ChecksumCRC64NVME -> (строка)

ChecksumSHA1 -> (строка)

ChecksumSHA256 -> (строка)

ChecksumType -> (строка)

ETag -> (строка)

MissingMeta -> (целое число)

VersionId -> (строка)

CacheControl -> (строка)

ContentDisposition -> (строка)

ContentEncoding -> (строка)

ContentLanguage -> (строка)

ContentType -> (строка)

ContentRange -> (строка)

Expires -> (метка времени)

ExpiresString -> (строка)

WebsiteRedirectLocation -> (строка)

ServerSideEncryption -> (строка)

Metadata -> (карта)

SSECustomerAlgorithm -> (строка)

SSECustomerKeyMD5 -> (строка)

SSEKMSKeyId -> (строка)

BucketKeyEnabled -> (boolean)

StorageClass -> (строка)

RequestCharged -> (строка)

ReplicationStatus -> (строка)

PartsCount -> (целое число)

ObjectLockMode -> (строка)

ObjectLockRetainUntilDate -> (метка времени)

ObjectLockLegalHoldStatus -> (строка)