Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

put-bucket-website

Описание

Примечание

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

Устанавливает конфигурацию веб-сайта, указанную в website подресурсе. Для настройки ведра в качестве веб-сайта можно добавить этот подресурс в ведро с информацией о конфигурации веб-сайта, такой как имя файла индексного документа и любые правила перенаправления. Дополнительную информацию см. в разделе Размещение веб-сайтов на Amazon S3.

Для выполнения этого действия PUT требуется разрешение S3:PutBucketWebsite. По умолчанию только владелец ведра может настроить веб-сайт, присоединенный к ведру; однако владельцы ведер могут разрешить другим пользователям устанавливать конфигурацию веб-сайта, написав политику ведра, которая предоставляет им разрешение S3:PutBucketWebsite.

Для перенаправления всех запросов веб-сайта, отправленных на конечную точку веб-сайта ведра, добавьте конфигурацию веб-сайта с указанными элементами. Поскольку все запросы отправляются на другой веб-сайт, вам не нужно указывать имя индексного документа для ведра.

  • WebsiteConfiguration
  • RedirectAllRequestsTo
  • HostName
  • Protocol

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

  • WebsiteConfiguration
  • IndexDocument
  • Suffix
  • ErrorDocument
  • Key
  • RoutingRules
  • RoutingRule
  • Condition
  • HttpErrorCodeReturnedEquals
  • KeyPrefixEquals
  • Redirect
  • Protocol
  • HostName
  • ReplaceKeyPrefixWith
  • ReplaceKeyWith
  • HttpRedirectCode

У Amazon S3 есть ограничение в 50 правил маршрутизации на одну конфигурацию веб-сайта. Если вам необходимо более 50 правил маршрутизации, вы можете использовать перенаправление объектов. Дополнительную информацию см. в разделе Настройка перенаправления объектов в Руководстве пользователя Amazon S3.

Максимальная длина запроса ограничена 128 КБ.

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

Синтаксис

  put-bucket-website
--bucket <value>
[--content-md5 <value>]
[--checksum-algorithm <value>]
--website-configuration <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 (строка)

Имя ведра.

--content-md5 (строка)

Базовое 128-битное MD5 хеш-значение, закодированное в Base64, данных. Вы должны использовать этот заголовок для проверки целостности сообщения, чтобы убедиться, что тело запроса не было повреждено во время передачи. Дополнительную информацию см. в RFC 1864.

Для запросов, выполненных с помощью командной строки Amazon Web Services (CLI) или SDK Amazon Web Services, это поле вычисляется автоматически.

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

Указывает алгоритм, используемый для создания контрольной суммы запроса при использовании SDK. Этот заголовок не предоставит дополнительных функций, если вы не используете SDK. Если вы отправляете этот заголовок, должен быть отправлен соответствующий заголовок x-amz-checksum или x-amz-trailer. В противном случае Amazon S3 отклоняет запрос со статусом HTTP 400 Bad Request. Дополнительную информацию см. в разделе Проверка целостности объектов в Руководстве пользователя Amazon S3.

Если вы предоставите отдельную контрольную сумму, Amazon S3 проигнорирует любой предоставленный параметр ChecksumAlgorithm.

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

  • CRC32
  • CRC32C
  • SHA1
  • SHA256
  • CRC64NVME

--website-configuration (структура)

Контейнер для запроса.

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

Имя документа ошибки для веб-сайта.

Key -> (строка)

Имя ключа объекта, используемое при возникновении ошибки класса 4XX.

Предупреждение

Необходимо заменить ключи объектов, содержащие специальные символы (такие как возвраты каретки), при использовании XML-запросов. Дополнительную информацию см. в разделе Ограничения ключей объектов, связанных с XML.

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

Имя индексного документа для веб-сайта.

Suffix -> (строка)

Суффикс, добавляемый к запросу, который относится к каталогу на конечной точке веб-сайта. (Например, если суффикс равен index.html, и вы отправляете запрос к samplebucket/images/, данные, которые возвращаются, будут относиться к объекту с именем ключа images/index.html.) Суффикс не должен быть пустым и не должен содержать символ косой черты.

Предупреждение

Необходимо заменить ключи объектов, содержащие специальные символы (такие как возвраты каретки), при использовании XML-запросов. Дополнительную информацию см. в разделе Ограничения ключей объектов, связанных с XML.

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

Поведение перенаправления для каждого запроса на конечную точку веб-сайта данного ведра.

Предупреждение

Если вы указываете этот параметр, вы не можете указать ни один другой параметр.

HostName -> (строка)

Имя хоста, на который перенаправляются запросы.

Protocol -> (строка)

Протокол, используемый при перенаправлении запросов. По умолчанию используется протокол, используемый в исходном запросе.

RoutingRules -> (список)

Правила, определяющие, когда применяется перенаправление, и поведение перенаправления.

(структура)

Определяет поведение перенаправления и условия его применения. Дополнительную информацию о правилах маршрутизации см. в разделе Настройка условных перенаправлений в Руководстве пользователя Amazon S3.

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

Контейнер для описания условия, которое должно быть выполнено для применения указанного перенаправления. Например, 1. Если запрос относится к страницам в папке /docs, перенаправьте запрос в папку /documents. 2. Если запрос приводит к ошибке HTTP 4xx, перенаправьте запрос на другой хост, где вы можете обработать ошибку.

HttpErrorCodeReturnedEquals -> (строка)

Код HTTP-ошибки, при котором применяется перенаправление. В случае ошибки, если код ошибки равен этому значению, то применяется указанное перенаправление. Требуется, когда родительский элемент Condition указан, а брат KeyPrefixEquals не указан. Если оба указаны, то оба условия должны быть истинными для применения перенаправления.

KeyPrefixEquals -> (строка)

Префикс имени ключа объекта, когда применяется перенаправление. Например, для перенаправления запросов на ExamplePage.html, префикс ключа будет ExamplePage.html. Для перенаправления запросов для всех страниц с префиксом docs/, префикс ключа будет /docs, что идентифицирует все объекты в папке docs/. Требуется, когда родительский элемент Condition указан, а брат HttpErrorCodeReturnedEquals не указан. Если оба условия указаны, оба должны быть истинными для применения перенаправления.

Предупреждение

Необходимо заменить ключи объектов, содержащие специальные символы (такие как возвраты каретки), при использовании XML-запросов. Дополнительную информацию см. в разделе Ограничения ключей объектов, связанных с XML.

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

Контейнер для информации о перенаправлении. Вы можете перенаправить запросы на другой хост, на другую страницу или с другим протоколом. В случае ошибки вы можете указать другой код ошибки, который следует вернуть.

HostName -> (строка)

Имя хоста, используемого в запросе перенаправления.

HttpRedirectCode -> (строка)

Код HTTP-перенаправления, используемый в ответе. Не требуется, если один из братьев присутствует.

Protocol -> (строка)

Протокол, используемый при перенаправлении запросов. По умолчанию используется протокол, используемый в исходном запросе.

ReplaceKeyPrefixWith -> (строка)

Префикс ключа объекта, используемый в запросе перенаправления. Например, для перенаправления запросов для всех страниц с префиксом docs/ (объекты в папке docs/) на documents/, вы можете установить блок условия с KeyPrefixEquals на docs/ и в перенаправлении установить ReplaceKeyPrefixWith на /documents. Необязательно, если один из братьев присутствует. Может присутствовать только если ReplaceKeyWith не указан.

Предупреждение

Необходимо заменить ключи объектов, содержащие специальные символы (такие как возвраты каретки), при использовании XML-запросов. Дополнительную информацию см. в разделе Ограничения ключей объектов, связанных с XML.

ReplaceKeyWith -> (строка)

Конкретный ключ объекта, используемый в запросе перенаправления. Например, перенаправление запроса на error.html. Необязательно, если один из братьев присутствует. Может присутствовать только если ReplaceKeyPrefixWith не указан.

Предупреждение

Необходимо заменить ключи объектов, содержащие специальные символы (такие как возвраты каретки), при использовании XML-запросов. Дополнительную информацию см. в разделе Ограничения ключей объектов, связанных с XML.

Синтаксис JSON:

{
  "ErrorDocument": {
    "Key": "string"
  },
  "IndexDocument": {
    "Suffix": "string"
  },
  "RedirectAllRequestsTo": {
    "HostName": "string",
    "Protocol": "http"|"https"
  },
  "RoutingRules": [
    {
      "Condition": {
        "HttpErrorCodeReturnedEquals": "string",
        "KeyPrefixEquals": "string"
      },
      "Redirect": {
        "HostName": "string",
        "HttpRedirectCode": "string",
        "Protocol": "http"|"https",
        "ReplaceKeyPrefixWith": "string",
        "ReplaceKeyWith": "string"
      }
    }
    ...
  ]
}

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

Примеры

Примечание

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

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

Применяет статическую конфигурацию веб-сайта к ведру с именем amzn-s3-demo-bucket:

aws s3api put-bucket-website --bucket amzn-s3-demo-bucket --website-configuration file://website.json

Файл website.json — это JSON-документ в текущей папке, который определяет индексные и страницы ошибок для веб-сайта:

{
    "IndexDocument": {
        "Suffix": "index.html"
    },
    "ErrorDocument": {
        "Key": "error.html"
    }
}

Вывод

Нет

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

Spec-Zone.ru

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