Spec-Zone.ru › AWS CLI v2

[ aws . workdocs ]

инициировать-загрузку-версии-документа

Описание

Создаёт новый объект документа и объект версии.

Клиент указывает идентификатор родительской папки и имя документа для загрузки. Идентификатор необязательно указывается при создании новой версии существующего документа. Это первый шаг загрузки документа. Далее, загрузите документ по URL-адресу, возвращённому в результате вызова, а затем вызовите UpdateDocumentVersion.

Для отмены загрузки документа вызовите AbortDocumentVersionUpload.

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

Синтаксис

  initiate-document-version-upload
[--authentication-token <value>]
[--id <value>]
[--name <value>]
[--content-created-timestamp <value>]
[--content-modified-timestamp <value>]
[--content-type <value>]
[--document-size-in-bytes <value>]
[--parent-folder-id <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]

Параметры

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

Токен аутентификации Amazon WorkDocs. Не требуется при использовании учетных данных администратора Amazon Web Services для доступа к API.

--id (строка)

Идентификатор документа.

--name (строка)

Имя документа.

--content-created-timestamp (временная метка)

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

--content-modified-timestamp (временная метка)

Временная метка, когда содержимое документа было изменено.

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

Тип содержимого документа.

--document-size-in-bytes (целое число)

Размер документа в байтах.

--parent-folder-id (строка)

Идентификатор родительской папки.

--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
  • text
  • таблица
  • 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 в руководстве пользователя AWS CLI.

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

Для инициирования загрузки версии документа

Следующий initiate-document-upload пример создает новый объект документа и объект версии.

aws workdocs initiate-document-version-upload \
    --name exampledocname \
    --parent-folder-id eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189

Вывод:

{
    "Metadata": {
        "Id": "feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2",
        "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
        "ParentFolderId": "eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189",
        "CreatedTimestamp": 1536773972.914,
        "ModifiedTimestamp": 1536773972.914,
        "LatestVersionMetadata": {
            "Id": "1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313",
            "Name": "exampledocname",
            "ContentType": "application/octet-stream",
            "Size": 0,
            "Status": "INITIALIZED",
            "CreatedTimestamp": 1536773972.914,
            "ModifiedTimestamp": 1536773972.914,
            "CreatorId": "arn:aws:iam::123456789123:user/EXAMPLE"
        },
        "ResourceState": "ACTIVE"
    },
    "UploadMetadata": {
        "UploadUrl": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2/1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313?X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180912T173932Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180912%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE",
        "SignedHeaders": {
            "Content-Type": "application/octet-stream",
            "x-amz-server-side-encryption": "ABC123"
        }
    }
}

Вывод

Метаданные -> (структура)

Метаданные документа.

Id -> (строка)

Идентификатор документа.

CreatorId -> (строка)

Идентификатор создателя.

ParentFolderId -> (строка)

Идентификатор родительской папки.

CreatedTimestamp -> (временная метка)

Время создания документа.

ModifiedTimestamp -> (временная метка)

Время обновления документа.

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

Последняя версия документа.

Id -> (строка)

Идентификатор версии.

Name -> (строка)

Имя версии.

ContentType -> (строка)

Тип содержимого документа.

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

Размер документа в байтах.

Signature -> (строка)

Подпись документа.

Status -> (строка)

Статус документа.

CreatedTimestamp -> (временная метка)

Временная метка первой загрузки документа.

ModifiedTimestamp -> (временная метка)

Временная метка последней загрузки документа.

ContentCreatedTimestamp -> (временная метка)

Временная метка первоначального создания содержимого документа.

ContentModifiedTimestamp -> (временная метка)

Временная метка изменения содержимого документа.

CreatorId -> (строка)

Идентификатор создателя.

Thumbnail -> (карта)

Миниатюра документа.

ключ -> (строка)

значение -> (строка)

Source -> (карта)

Источник документа.

ключ -> (строка)

значение -> (строка)

ResourceState -> (строка)

Состояние ресурса.

Labels -> (список)

Список меток документа.

(строка)

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

Метаданные загрузки.

UploadUrl -> (строка)

URL загрузки.

SignedHeaders -> (карта)

Подписанные заголовки.

ключ -> (строка)

значение -> (строка)

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

Spec-Zone.ru

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