Spec-Zone.ru › AWS CLI v2

[ aws . workdocs ]

get-resources

Описание

Получает набор ресурсов, включая папки и документы. Поддерживается только CollectionType SHARED_WITH_ME .

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

Синтаксис

  get-resources
[--authentication-token <value>]
[--user-id <value>]
[--collection-type <value>]
[--limit <value>]
[--marker <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.

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

Идентификатор пользователя для набора ресурсов. Это обязательное поле для доступа к операции API с использованием учетных данных IAM.

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

Тип набора.

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

  • SHARED_WITH_ME

--limit (целое число)

Максимальное количество ресурсов для возврата.

--marker (строка)

Маркер для следующего набора результатов. Этот маркер был получен из предыдущего вызова.

--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
  • текст
  • таблица
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для получения общих ресурсов

Следующий get-resources пример получает ресурсы, предоставленные указанному пользователю Amazon WorkDocs.

aws workdocs get-resources \
    --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333" \
    --collection-type SHARED_WITH_ME

Вывод:

{
"Folders": [],
"Documents": []
}

Дополнительную информацию см. в разделе «Обмен файлами и папками» в руководстве пользователя Amazon WorkDocs.

Вывод

Папки -> (список)

Папки в указанной папке.

(структура)

Описание папки.

Id -> (строка)

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

Name -> (строка)

Название папки.

CreatorId -> (строка)

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

ParentFolderId -> (строка)

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

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

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

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

Время обновления папки.

ResourceState -> (строка)

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

Signature -> (строка)

Уникальный идентификатор, созданный из подпапок и документов папки.

Labels -> (список)

Список меток папки.

(строка)

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

Размер метаданных папки.

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

Размер последней версии метаданных папки.

Документы -> (список)

Документы в указанном наборе.

(структура)

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

Id -> (строка)

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

CreatorId -> (строка)

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

ParentFolderId -> (строка)

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

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

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

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

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

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

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

Id -> (строка)

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

Name -> (строка)

Название версии.

ContentType -> (строка)

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

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

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

Signature -> (строка)

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

Status -> (строка)

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

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

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

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

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

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

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

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

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

CreatorId -> (строка)

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

Thumbnail -> (карта)

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

key -> (строка)

value -> (строка)

Source -> (карта)

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

key -> (строка)

value -> (строка)

ResourceState -> (строка)

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

Labels -> (список)

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

(строка)

Marker -> (строка)

Маркер для запроса следующего набора результатов. Если дополнительных результатов нет, строка пуста.

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

Spec-Zone.ru

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