Spec-Zone.ru › AWS CLI v2

[ aws . codecommit ]

get-folder

Описание

Возвращает содержимое указанной папки в репозитории.

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

Синтаксис

  get-folder
--repository-name <value>
[--commit-specifier <value>]
--folder-path <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]

Параметры

--repository-name (строка)

Название репозитория.

--commit-specifier (строка)

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

--folder-path (строка)

Полный путь к папке, содержимое которой возвращается, включая имя папки. Например, /examples — это полный путь к папке с именем examples, созданной из корневого каталога (/) репозитория.

--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-auto-prompt (логическое)

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

--no-cli-auto-prompt (логическое)

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

Примеры

Примечание

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

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

Получение содержимого папки в репозитории AWS CodeCommit

Следующий get-folder пример демонстрирует, как получить содержимое папки верхнего уровня из репозитория с именем MyDemoRepo.

aws codecommit get-folder --repository-name MyDemoRepo --folder-path ""

Вывод:

{
    "commitId":"c5709475EXAMPLE",
    "files":[
        {
            "absolutePath":".gitignore",
            "blobId":"74094e8bEXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":".gitignore"
        },
        {
            "absolutePath":"Gemfile",
            "blobId":"9ceb72f6EXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"Gemfile"
        },
        {
            "absolutePath":"Gemfile.lock",
            "blobId":"795c4a2aEXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"Gemfile.lock"
        },
        {
            "absolutePath":"LICENSE.txt",
            "blobId":"0c7932c8EXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"LICENSE.txt"
        },
        {
            "absolutePath":"README.md",
            "blobId":"559b44feEXAMPLE",
            "fileMode":"NORMAL",
            "relativePath":"README.md"
        }
    ],
    "folderPath":"",
    "subFolders":[
        {
            "absolutePath":"public",
            "relativePath":"public",
            "treeId":"d5e92ae3aEXAMPLE"
        },
        {
            "absolutePath":"tmp",
            "relativePath":"tmp",
            "treeId":"d564d0bcEXAMPLE"
        }
    ],
    "subModules":[],
    "symbolicLinks":[],
    "treeId":"7b3c4dadEXAMPLE"
}

Дополнительную информацию см. в разделе GetFolder в руководстве по справке API AWS CodeCommit.

Вывод

commitId -> (строка)

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

folderPath -> (строка)

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

treeId -> (строка)

Полный SHA-1 указатель информации о дереве для коммита, содержащего папку.

subFolders -> (список)

Список папок, которые существуют в указанной папке, если таковые имеются.

(структура)

Возвращает информацию о папке в репозитории.

treeId -> (строка)

Полный SHA-1 указатель информации о дереве для коммита, содержащего папку.

absolutePath -> (строка)

Полный путь к папке в репозитории.

relativePath -> (строка)

Относительный путь указанной папки от папки, из которой исходил запрос.

files -> (список)

Список файлов в указанной папке, если таковые имеются.

(структура)

Возвращает информацию о файле в репозитории.

blobId -> (строка)

Идентификатор blob, содержащий информацию о файле.

absolutePath -> (строка)

Полный путь к файлу в репозитории.

relativePath -> (строка)

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

fileMode -> (строка)

Разрешения на экстраполяцию режима файла для файла. Допустимые значения включают EXECUTABLE и NORMAL.

symbolicLinks -> (список)

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

(структура)

Возвращает информацию о символической ссылке в папке репозитория.

blobId -> (строка)

Идентификатор blob, содержащий информацию о символической ссылке.

absolutePath -> (строка)

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

relativePath -> (строка)

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

fileMode -> (строка)

Разрешения режима файла blob, содержащего информацию о символической ссылке.

subModules -> (список)

Список подмодулей в указанной папке, если таковые имеются.

(структура)

Возвращает информацию о ссылке подмодуля в папке репозитория.

commitId -> (строка)

Идентификатор коммита, содержащий ссылку на подмодуль.

absolutePath -> (строка)

Полный путь к папке, содержащей ссылку на подмодуль.

relativePath -> (строка)

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

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

Spec-Zone.ru

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