Skip to main content

repository_catalog_datas

Creates, updates, deletes, gets or lists a repository_catalog_datas resource.

Overview

Namerepository_catalog_datas
TypeResource
Idaws.ecr_public.repository_catalog_datas

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
about_textstringThe longform description of the contents of the repository. This text appears in the repository details on the Amazon ECR Public Gallery.
architecturesarrayThe architecture tags that are associated with the repository. Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput.
descriptionstringThe short description of the repository.
logo_urlstringThe URL that contains the logo that's associated with the repository.
marketplace_certifiedbooleanIndicates whether the repository is certified by Amazon Web Services Marketplace.
operating_systemsarrayThe operating system tags that are associated with the repository. Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput.
usage_textstringThe longform usage details of the contents of the repository. The usage text provides context for users of the repository.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_repository_catalog_dataselectregionRetrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
put_repository_catalog_datareplaceregion, repositoryName, catalogDataCreates or updates the catalog data for a repository in a public registry.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.

SELECT
about_text,
architectures,
description,
logo_url,
marketplace_certified,
operating_systems,
usage_text
FROM aws.ecr_public.repository_catalog_datas
WHERE region = '{{ region }}' -- required
;

REPLACE examples

Creates or updates the catalog data for a repository in a public registry.

REPLACE aws.ecr_public.repository_catalog_datas
SET
registryId = '{{ registryId }}',
repositoryName = '{{ repositoryName }}',
catalogData = '{{ catalogData }}'
WHERE
region = '{{ region }}' --required
AND repositoryName = '{{ repositoryName }}' --required
AND catalogData = '{{ catalogData }}' --required
RETURNING
catalog_data;