Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

list-multipart-uploads

Описание

Данная операция перечисляет находящиеся в процессе многочастные загрузки в ведре. Многочастная загрузка в процессе — это многочастная загрузка, которая была инициирована запросом CreateMultipartUpload, но еще не завершена или прервана.

Примечание

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

Операция ListMultipartUploads возвращает максимум 1000 многочастных загрузок в ответе. Предел в 1000 многочастных загрузок также является значением по умолчанию. Вы можете дополнительно ограничить количество загрузок в ответе, указав параметр запроса max-uploads. Если существует более 1000 многочастных загрузок, удовлетворяющих вашему запросу ListMultipartUploads, ответ возвращает элемент IsTruncated со значением true, элемент NextKeyMarker и элемент NextUploadIdMarker. Для перечисления оставшихся многочастных загрузок необходимо сделать последующие запросы ListMultipartUploads. В этих запросах включите два параметра запроса: key-marker и upload-id-marker. Установите значение key-marker на значение NextKeyMarker из предыдущего ответа. Аналогично, установите значение upload-id-marker на значение NextUploadIdMarker из предыдущего ответа.

Примечание

Ведра каталогов - Элемент upload-id-marker и элемент NextUploadIdMarker не поддерживаются ведрами каталогов. Для перечисления дополнительных многочастных загрузок вам нужно только установить значение key-marker на значение NextKeyMarker из предыдущего ответа.

Дополнительную информацию о многочастных загрузках см. в разделе Загрузка объектов с помощью многочастной загрузки в Руководстве пользователя Amazon S3.

Примечание

Ведра каталогов - Для ведер каталогов необходимо выполнять запросы для этой операции API к зоновому конечной точке. Эти конечные точки поддерживают запросы в стиле виртуального хостинга в формате ``https://amzn-s3-demo-bucket .s3express-zone-id .*region-code* .amazonaws.com/key-name `` . Запросы в стиле пути не поддерживаются. Дополнительную информацию о конечных точках в зонах доступности см. в разделе Региональные и зональные конечные точки для ведер каталогов в зонах доступности в Руководстве пользователя Amazon S3. Дополнительную информацию о конечных точках в локальных зонах см. в разделе Концепции для ведер каталогов в локальных зонах в Руководстве пользователя Amazon S3.

Разрешения

  • Разрешения на ведра общего назначения - Дополнительную информацию о разрешениях, необходимых для использования API многочастной загрузки, см. в разделе Многочастная загрузка и разрешения в Руководстве пользователя Amazon S3.

  • Разрешения на ведра каталогов - Для предоставления доступа к этой операции 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`__.

    Сортировка многочастных загрузок в ответе

  • Ведро общего назначения - В ответе ListMultipartUploads многочастные загрузки сортируются по двум критериям:

    • Сортировка по имени ключа - Многочастные загрузки первоначально сортируются в порядке возрастания по имени ключа объекта.
    • Сортировка по времени - Для загрузок с одинаковым именем ключа объекта они дополнительно сортируются в порядке возрастания по времени инициирования загрузки. Среди загрузок с одинаковым ключом та, которая была инициирована первой, будет отображаться перед теми, которые были инициированы позже.
  • Ведро каталога - В ответе ListMultipartUploads многочастные загрузки не сортируются лексикографически по именам ключей объектов.

    Синтаксис заголовка HTTP Host

Ведра каталогов - Синтаксис заголовка HTTP Host - `` Имя_ведр .s3express-идентификатор_зоны .*код_региона* .amazonaws.com`` .

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

  • CreateMultipartUpload
  • UploadPart
  • CompleteMultipartUpload
  • ListParts
  • AbortMultipartUpload

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

list-multipart-uploads — это операция с постраничным выводом. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом аргумент --query должен извлекать данные из результатов следующих выражений запроса: Uploads, CommonPrefixes

Синтаксис

  list-multipart-uploads
--bucket <value>
[--delimiter <value>]
[--encoding-type <value>]
[--prefix <value>]
[--expected-bucket-owner <value>]
[--request-payer <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 см. в разделе Что такое S3 в Outposts? в руководстве пользователя Amazon S3.

--delimiter (строка)

Символ, используемый для группировки ключей.

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

Примечание

Ведра каталогов — Для ведер каталогов / является единственным поддерживаемым разделителем.

--encoding-type (строка)

Тип кодирования, используемый Amazon S3 для кодирования ключей объектов в ответе. Ответы кодируются только в UTF-8. Ключ объекта может содержать любой символ Unicode. Однако парсер XML 1.0 не может анализировать некоторые символы, такие как символы с ASCII-значением от 0 до 10. Для символов, которые не поддерживаются в XML 1.0, можно добавить этот параметр, чтобы запросить кодировку ключей в ответе Amazon S3. Дополнительную информацию о символах, которых следует избегать в именах ключей объектов, см. в разделе Руководство по именованию ключей объектов.

Примечание

При использовании типа кодирования URL не ASCII-символы, используемые в имени ключа объекта, будут кодироваться по процентам в соответствии со значениями кода UTF-8. Например, объект test_file(3).png будет отображаться как test_file%283%29.png .

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

  • url

--prefix (строка)

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

Примечание

Ведра каталогов — Для ведер каталогов поддерживаются только префиксы, заканчивающиеся разделителем (/ ).

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

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

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

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

Примечание

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

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

  • requester

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные данные с помощью значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания места начала постраничной обработки. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

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

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS Command Line Interface.

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

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

aws s3api list-multipart-uploads --bucket amzn-s3-demo-bucket

Вывод:

{
    "Uploads": [
        {
            "Initiator": {
                "DisplayName": "username",
                "ID": "arn:aws:iam::0123456789012:user/username"
            },
            "Initiated": "2015-06-02T18:01:30.000Z",
            "UploadId": "dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R",
            "StorageClass": "STANDARD",
            "Key": "multipart/01",
            "Owner": {
                "DisplayName": "aws-account-name",
                "ID": "100719349fc3b6dcd7c820a124bf7aecd408092c3d7b51b38494939801fc248b"
            }
        }
    ],
    "CommonPrefixes": []
}

Активные многочастные загрузки влечет за собой расходы на хранение в Amazon S3. Завершите или прервите активную многочастную загрузку, чтобы удалить ее части из вашего аккаунта.

Вывод

Bucket -> (строка)

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

KeyMarker -> (строка)

Ключ, с которого начался перечень.

UploadIdMarker -> (строка)

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

Примечание

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

NextKeyMarker -> (строка)

Если список усечён, этот элемент указывает значение, которое следует использовать для параметра key-marker в последующем запросе.

Prefix -> (строка)

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

Примечание

Ведра с каталогами - Для ведер с каталогами поддерживаются только префиксы, заканчивающиеся разделителем (/).

Delimiter -> (строка)

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

Примечание

Ведра с каталогами - Для ведер с каталогами / является единственным поддерживаемым разделителем.

NextUploadIdMarker -> (строка)

Если список усечен, этот элемент указывает значение, которое следует использовать для параметра upload-id-marker в последующем запросе.

Примечание

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

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

Максимальное количество многочастных загрузок, которые могли быть включены в ответ.

IsTruncated -> (булево)

Указывает, усечён ли возвращённый список многочастных загрузок. Значение true указывает, что список был усечён. Список может быть усечён, если количество многочастных загрузок превышает допустимый или заданный предел max uploads.

Uploads -> (список)

Контейнер для элементов, относящихся к конкретной многочастной загрузке. Ответ может содержать ноль или более Upload элементов.

(структура)

Контейнер для MultipartUpload объекта Amazon S3.

UploadId -> (строка)

Идентификатор загрузки, который идентифицирует многочастную загрузку.

Key -> (строка)

Ключ объекта, для которого была инициирована многочастная загрузка.

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

Дата и время начала многочастной загрузки.

StorageClass -> (строка)

Класс хранения, используемый для хранения объекта.

Примечание

Ведра с каталогами - Ведра с каталогами поддерживают только EXPRESS_ONEZONE (класс хранения S3 Express One Zone) в зонах доступности и ONEZONE_IA (класс хранения S3 One Zone-Infrequent Access) в выделенных локальных зонах.

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

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

Примечание

Ведра с каталогами - Владелец ведра возвращается как владелец объекта для всех объектов.

DisplayName -> (строка)

Контейнер для отображаемого имени владельца. Это значение поддерживается только в следующих регионах Amazon Web Services:

  • US East (N. Virginia)
  • US West (N. California)
  • US West (Oregon)
  • Asia Pacific (Singapore)
  • Asia Pacific (Sydney)
  • Asia Pacific (Tokyo)
  • Europe (Ireland)
  • South America (São Paulo)

Примечание

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

ID -> (строка)

Контейнер для ID владельца.

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

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

ID -> (строка)

Если субъект – учетная запись Amazon Web Services, предоставляется канонический ID пользователя. Если субъект – пользователь IAM, предоставляется значение ARN пользователя.

Примечание

Ведра с каталогами - Если субъект – учетная запись Amazon Web Services, предоставляется ID учетной записи Amazon Web Services. Если субъект – пользователь IAM, предоставляется значение ARN пользователя.

DisplayName -> (строка)

Имя субъекта.

Примечание

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

ChecksumAlgorithm -> (строка)

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

ChecksumType -> (строка)

Тип контрольной суммы, используемый для расчета значения контрольной суммы объекта. Дополнительную информацию см. в разделе "Проверка целостности объектов" в Руководстве пользователя Amazon S3.

CommonPrefixes -> (список)

Если в запросе указан разделитель, результат возвращает каждый уникальный префикс ключа, содержащий разделитель, в элементе CommonPrefixes. Уникальные префиксы ключей возвращаются в элементе Prefix.

Примечание

Ведра с каталогами - Для ведер с каталогами поддерживаются только префиксы, заканчивающиеся разделителем (/).

(структура)

Контейнер для всех (если они есть) ключей между префиксом и следующим вхождением строки, заданной разделителем. CommonPrefixes перечисляет ключи, которые действуют как подкаталоги в каталоге, указанном префиксом. Например, если префикс - notes/, а разделитель - косая черта (/), как в notes/summer/july, общий префикс - notes/summer/.

Prefix -> (строка)

Контейнер для указанного общего префикса.

EncodingType -> (строка)

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

Если вы укажете параметр encoding-type запроса, Amazon S3 включит этот элемент в ответ и вернёт закодированные значения имён ключей в следующих элементах ответа:

Delimiter , KeyMarker , Prefix , NextKeyMarker , Key .

RequestCharged -> (строка)

При наличии указывает, что запрашивающий был успешно уплачен за запрос.

Примечание

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

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

Spec-Zone.ru

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