Amazon Elastic Container Registry Public

2021/02/24 - Amazon Elastic Container Registry Public - 3 new 1 updated api methods

Changes  This release adds support for AWS tags on Amazon ECR Public repositories.

ListTagsForResource (new) Link ¶

List the tags for an Amazon ECR Public resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)
type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resource is an Amazon ECR Public repository.

rtype

dict

returns

Response Syntax

{
    'tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • tags (list) --

      The tags for the resource.

      • (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, both of which you define. 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).

TagResource (new) Link ¶

Associates the specified tags to a resource with the specified resourceArn . If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resource is an Amazon ECR Public repository.

type tags

list

param tags

[REQUIRED]

The tags to add to the resource. A tag is an array of key-value pairs. 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, both of which you define. 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).

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

UntagResource (new) Link ¶

Deletes specified tags from a resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
type resourceArn

string

param resourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resource is an Amazon ECR Public repository.

type tagKeys

list

param tagKeys

[REQUIRED]

The keys of the tags to be removed.

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

CreateRepository (updated) Link ¶
Changes (request) 
{'tags': [{'Key': 'string', 'Value': 'string'}]}

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

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

string

param repositoryName

[REQUIRED]

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

type catalogData

dict

param catalogData

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 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 (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 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.

type tags

list

param tags

The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. 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, both of which you define. 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).

rtype

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, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test .

      • registryId (string) --

        The AWS account ID 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 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.