ECRPublic / Client / create_repository

create_repository#

ECRPublic.Client.create_repository(**kwargs)#

Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.

See also: AWS API Documentation

Request Syntax

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

  • repositoryName (string) –

    [REQUIRED]

    The name to use for the repository. This appears publicly in the Amazon ECR Public Gallery. The repository name can be specified on its own (for example nginx-web-app) or prepended with a namespace to group the repository into a category (for example project-a/nginx-web-app).

  • catalogData (dict) –

    The details about the repository that are 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.

  • tags (list) –

    The metadata that you apply to each repository to help categorize and organize your repositories. Each tag consists of a key and an optional value. You define both of them. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    • (dict) –

      The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • Key (string) –

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value (string) –

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Return type:

dict

Returns:

Response Syntax

{
    'repository': {
        'repositoryArn': 'string',
        'registryId': 'string',
        'repositoryName': 'string',
        'repositoryUri': 'string',
        'createdAt': datetime(2015, 1, 1)
    },
    'catalogData': {
        'description': 'string',
        'architectures': [
            'string',
        ],
        'operatingSystems': [
            'string',
        ],
        'logoUrl': 'string',
        'aboutText': 'string',
        'usageText': 'string',
        'marketplaceCertified': True|False
    }
}

Response Structure

  • (dict) –

    • repository (dict) –

      The repository that was created.

      • repositoryArn (string) –

        The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test.

      • registryId (string) –

        The Amazon Web Services account ID that’s associated with the public registry that contains the repository.

      • repositoryName (string) –

        The name of the repository.

      • repositoryUri (string) –

        The URI for the repository. You can use this URI for container image push and pull operations.

      • createdAt (datetime) –

        The date and time, in JavaScript date format, when the repository was created.

    • catalogData (dict) –

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

      • 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