Spec-Zone.ru › AWS CLI v2

[ aws . ecr-public ]

put-repository-catalog-data

Описание

Создаёт или обновляет данные каталога для репозитория в общедоступном реестре.

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

Синтаксис

  put-repository-catalog-data
[--registry-id <value>]
--repository-name <value>
--catalog-data <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]

Параметры

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

Идентификатор учётной записи Amazon Web Services, связанный с общедоступным реестром, в котором находится репозиторий. Если вы не укажете реестр, будет использован по умолчанию общедоступный реестр.

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

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

--catalog-data (структура)

Объект, содержащий данные каталога репозитория. Эти данные общедоступны в Amazon ECR Public Gallery.

description -> (строка)

Краткое описание содержимого репозитория. Этот текст отображается как в деталях изображения, так и при поиске репозиториев в Amazon ECR Public Gallery.

architectures -> (список)

Архитектура системы, с которой совместимы изображения в репозитории. В Amazon ECR Public Gallery следующие поддерживаемые архитектуры отображаются как значки на репозитории и используются в качестве фильтров поиска.

Примечание

Если тег, не поддерживаемый системой, добавлен в данные каталога вашего репозитория, он связан с репозиторием и может быть получен с помощью API, но не отображается в Amazon ECR Public Gallery.
  • ARM
  • ARM 64
  • x86
  • x86-64

(строка)

operatingSystems -> (список)

Операционные системы, с которыми совместимы изображения в репозитории. В Amazon ECR Public Gallery следующие поддерживаемые операционные системы отображаются как значки на репозитории и используются в качестве фильтров поиска.

Примечание

Если тег, не поддерживаемый системой, добавлен в данные каталога вашего репозитория, он связан с репозиторием и может быть получен с помощью API, но не отображается в Amazon ECR Public Gallery.
  • Linux
  • Windows

(строка)

logoImageBlob -> (байтовый массив)

Загруженный логотип репозитория в формате base64.

Примечание

Логотип репозитория виден только в Amazon ECR Public Gallery для проверенных учётных записей.

aboutText -> (строка)

Подробное описание содержимого репозитория. Оно отображается в Amazon ECR Public Gallery. Текст должен быть в формате Markdown.

usageText -> (строка)

Подробная информация о том, как использовать содержимое репозитория. Она отображается в Amazon ECR Public Gallery. Текст содержит контекст, справочную информацию и дополнительные детали для пользователей репозитория. Текст должен быть в формате Markdown.

Краткая запись:

description=string,architectures=string,string,operatingSystems=string,string,logoImageBlob=blob,aboutText=string,usageText=string

Синтаксис JSON:

{
  "description": "string",
  "architectures": ["string", ...],
  "operatingSystems": ["string", ...],
  "logoImageBlob": blob,
  "aboutText": "string",
  "usageText": "string"
}

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

Для создания или обновления данных каталога репозитория в общедоступном реестре

Следующий put-repository-catalog-data пример создаёт или обновляет данные каталога для репозитория с именем project-a/nginx-web-app в общедоступном реестре, а также включает информацию о logoImageBlob, aboutText, usageText и тегах.

aws ecr-public put-repository-catalog-data \
    --repository-name project-a/nginx-web-app \
    --cli-input-json file://repository-catalog-data.json \
    --region us-east-1

Содержимое repository-catalog-data.json:

{
    "repositoryName": "project-a/nginx-web-app",
    "catalogData": {
        "description": "My project-a ECR Public Repository",
        "architectures": [
            "ARM",
            "ARM 64",
            "x86",
            "x86-64"
        ],
        "operatingSystems": [
            "Linux"
        ],
        "logoImageBlob": "iVBORw0KGgoA<<truncated-for-better-reading>>ErkJggg==",
        "aboutText": "## Quick reference.",
        "usageText": "## Supported architectures are as follows."
    }
}

Вывод:

{
    "catalogData": {
        "description": "My project-a ECR Public Repository",
        "architectures": [
            "ARM",
            "ARM 64",
            "x86",
            "x86-64"
        ],
        "operatingSystems": [
            "Linux"
        ],
        "logoUrl": "https://d3g9o9u8re44ak.cloudfront.net/logo/df86cf58-ee60-4061-b804-0be24d97ccb1/4a9ed9b2-69e4-4ede-b924-461462d20ef0.png",
        "aboutText": "## Quick reference.",
        "usageText": "## Supported architectures are as follows."
    }
}

Дополнительную информацию см. в разделе Данные каталога репозитория в Amazon ECR Public.

Вывод

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

Данные каталога репозитория.

description -> (строка)

Краткое описание репозитория.

architectures -> (список)

Теги архитектуры, связанные с репозиторием.

Примечание

Только поддерживаемые теги операционных систем отображаются публично в Amazon ECR Public Gallery. Дополнительную информацию см. в RepositoryCatalogDataInput.

(строка)

operatingSystems -> (список)

Теги операционных систем, связанные с репозиторием.

Примечание

Только поддерживаемые теги операционных систем отображаются публично в Amazon ECR Public Gallery. Дополнительную информацию см. в RepositoryCatalogDataInput.

(строка)

logoUrl -> (строка)

URL, содержащий логотип, связанный с репозиторием.

aboutText -> (строка)

Подробное описание содержимого репозитория. Этот текст отображается в деталях репозитория на Amazon ECR Public Gallery.

usageText -> (строка)

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

marketplaceCertified -> (логическое значение)

Указывает, сертифицирован ли репозиторий Amazon Web Services Marketplace.

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

Spec-Zone.ru

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