[ aws . ecr-public ]

put-repository-catalog-data

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-repository-catalog-data
[--registry-id <value>]
--repository-name <value>
--catalog-data <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--registry-id (string)

The AWS account ID associated with the public registry the repository is in. If you do not specify a registry, the default public registry is assumed.

--repository-name (string)

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

--catalog-data (structure)

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 will appear as badges on the repository and are used as search filters.

• Linux

• Windows

Note

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

(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 will appear as badges on the repository and are used as search filters.

• ARM

• ARM 64

• x86

• x86-64

Note

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

(string)

logoImageBlob -> (blob)

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 is publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format.

usageText -> (string)

Detailed information on how to use the contents of the repository. It is 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.

Shorthand Syntax:

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

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

catalogData -> (structure)

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 containing the logo 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)

Whether or not the repository is certified by AWS Marketplace.