ECRPublic / Client / get_repository_catalog_data
get_repository_catalog_data#
- ECRPublic.Client.get_repository_catalog_data(**kwargs)#
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
See also: AWS API Documentation
Request Syntax
response = client.get_repository_catalog_data( registryId='string', repositoryName='string' )
- Parameters:
registryId (string) – The Amazon Web Services account ID that’s associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository to retrieve the catalog metadata for.
- Return type:
dict
- Returns:
Response Syntax
{ 'catalogData': { 'description': 'string', 'architectures': [ 'string', ], 'operatingSystems': [ 'string', ], 'logoUrl': 'string', 'aboutText': 'string', 'usageText': 'string', 'marketplaceCertified': True|False } }
Response Structure
(dict) –
catalogData (dict) –
The catalog metadata for the repository.
description (string) –
The short description of the repository.
architectures (list) –
The architecture tags that are associated with the repository.
Note
Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput.
(string) –
operatingSystems (list) –
The operating system tags that are associated with the repository.
Note
Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput.
(string) –
logoUrl (string) –
The URL that contains the logo that’s associated with the repository.
aboutText (string) –
The longform description of the contents of the repository. This text appears in the repository details on the Amazon ECR Public Gallery.
usageText (string) –
The longform usage details of the contents of the repository. The usage text provides context for users of the repository.
marketplaceCertified (boolean) –
Indicates whether the repository is certified by Amazon Web Services Marketplace.
Exceptions