ECRPublic / Client / put_repository_catalog_data

put_repository_catalog_data#

ECRPublic.Client.put_repository_catalog_data(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.put_repository_catalog_data(
    registryId='string',
    repositoryName='string',
    catalogData={
        'description': 'string',
        'architectures': [
            'string',
        ],
        'operatingSystems': [
            'string',
        ],
        'logoImageBlob': b'bytes',
        'aboutText': 'string',
        'usageText': 'string'
    }
)
Parameters:

  • registryId (string) – The Amazon Web Services account ID that’s associated with the public registry the repository is in. If you do not specify a registry, the default public registry is assumed.

  • repositoryName (string) –

    [REQUIRED]

    The name of the repository to create or update the catalog data for.

  • catalogData (dict) –

    [REQUIRED]

    An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.

    • description (string) –

      A short description of the contents of the repository. This text appears in both the image details and also when searching for repositories on the Amazon ECR Public Gallery.

    • architectures (list) –

      The system architecture that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported architectures appear as badges on the repository and are used as search filters.

      Note

      If an unsupported tag is added to your repository catalog data, it’s associated with the repository and can be retrieved using the API but isn’t discoverable in the Amazon ECR Public Gallery.

      • ARM

      • ARM 64

      • x86

      • x86-64

      • (string) –

    • operatingSystems (list) –

      The operating systems that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported operating systems appear as badges on the repository and are used as search filters.

      Note

      If an unsupported tag is added to your repository catalog data, it’s associated with the repository and can be retrieved using the API but isn’t discoverable in the Amazon ECR Public Gallery.

      • Linux

      • Windows

      • (string) –

    • logoImageBlob (bytes) –

      The base64-encoded repository logo payload.

      Note

      The repository logo is only publicly visible in the Amazon ECR Public Gallery for verified accounts.

    • aboutText (string) –

      A detailed description of the contents of the repository. It’s publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format.

    • usageText (string) –

      Detailed information about how to use the contents of the repository. It’s publicly visible in the Amazon ECR Public Gallery. The usage text provides context, support information, and additional usage details for users of the repository. The text must be in markdown format.

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