Skip to content

ECRPublicClient#

Index > ECRPublic > ECRPublicClient

Auto-generated documentation for ECRPublic type annotations stubs module mypy-boto3-ecr-public.

ECRPublicClient#

Type annotations and code completion for boto3.client("ecr-public"). boto3 documentation

# ECRPublicClient usage example

from boto3.session import Session
from mypy_boto3_ecr_public.client import ECRPublicClient

def get_ecr-public_client() -> ECRPublicClient:
    return Session().client("ecr-public")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("ecr-public").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("ecr-public")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.EmptyUploadException,
    client.exceptions.ImageAlreadyExistsException,
    client.exceptions.ImageDigestDoesNotMatchException,
    client.exceptions.ImageNotFoundException,
    client.exceptions.ImageTagAlreadyExistsException,
    client.exceptions.InvalidLayerException,
    client.exceptions.InvalidLayerPartException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidTagParameterException,
    client.exceptions.LayerAlreadyExistsException,
    client.exceptions.LayerPartTooSmallException,
    client.exceptions.LayersNotFoundException,
    client.exceptions.LimitExceededException,
    client.exceptions.ReferencedImagesNotFoundException,
    client.exceptions.RegistryNotFoundException,
    client.exceptions.RepositoryAlreadyExistsException,
    client.exceptions.RepositoryCatalogDataNotFoundException,
    client.exceptions.RepositoryNotEmptyException,
    client.exceptions.RepositoryNotFoundException,
    client.exceptions.RepositoryPolicyNotFoundException,
    client.exceptions.ServerException,
    client.exceptions.TooManyTagsException,
    client.exceptions.UnsupportedCommandException,
    client.exceptions.UploadNotFoundException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_ecr_public.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

batch_check_layer_availability#

Checks the availability of one or more image layers that are within a repository in a public registry.

Type annotations and code completion for boto3.client("ecr-public").batch_check_layer_availability method. boto3 documentation

# batch_check_layer_availability method definition

def batch_check_layer_availability(
    self,
    *,
    repositoryName: str,
    layerDigests: Sequence[str],
    registryId: str = ...,
) -> BatchCheckLayerAvailabilityResponseTypeDef:  # (1)
    ...
  1. See BatchCheckLayerAvailabilityResponseTypeDef 
# batch_check_layer_availability method usage example with argument unpacking

kwargs: BatchCheckLayerAvailabilityRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "layerDigests": ...,
}

parent.batch_check_layer_availability(**kwargs)
  1. See BatchCheckLayerAvailabilityRequestRequestTypeDef

batch_delete_image#

Deletes a list of specified images that are within a repository in a public registry.

Type annotations and code completion for boto3.client("ecr-public").batch_delete_image method. boto3 documentation

# batch_delete_image method definition

def batch_delete_image(
    self,
    *,
    repositoryName: str,
    imageIds: Sequence[ImageIdentifierTypeDef],  # (1)
    registryId: str = ...,
) -> BatchDeleteImageResponseTypeDef:  # (2)
    ...
  1. See ImageIdentifierTypeDef
  2. See BatchDeleteImageResponseTypeDef 
# batch_delete_image method usage example with argument unpacking

kwargs: BatchDeleteImageRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "imageIds": ...,
}

parent.batch_delete_image(**kwargs)
  1. See BatchDeleteImageRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("ecr-public").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("ecr-public").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

complete_layer_upload#

Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID.

Type annotations and code completion for boto3.client("ecr-public").complete_layer_upload method. boto3 documentation

# complete_layer_upload method definition

def complete_layer_upload(
    self,
    *,
    repositoryName: str,
    uploadId: str,
    layerDigests: Sequence[str],
    registryId: str = ...,
) -> CompleteLayerUploadResponseTypeDef:  # (1)
    ...
  1. See CompleteLayerUploadResponseTypeDef 
# complete_layer_upload method usage example with argument unpacking

kwargs: CompleteLayerUploadRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "uploadId": ...,
    "layerDigests": ...,
}

parent.complete_layer_upload(**kwargs)
  1. See CompleteLayerUploadRequestRequestTypeDef

create_repository#

Creates a repository in a public registry.

Type annotations and code completion for boto3.client("ecr-public").create_repository method. boto3 documentation

# create_repository method definition

def create_repository(
    self,
    *,
    repositoryName: str,
    catalogData: RepositoryCatalogDataInputTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateRepositoryResponseTypeDef:  # (3)
    ...
  1. See RepositoryCatalogDataInputTypeDef
  2. See TagTypeDef
  3. See CreateRepositoryResponseTypeDef 
# create_repository method usage example with argument unpacking

kwargs: CreateRepositoryRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.create_repository(**kwargs)
  1. See CreateRepositoryRequestRequestTypeDef

delete_repository#

Deletes a repository in a public registry.

Type annotations and code completion for boto3.client("ecr-public").delete_repository method. boto3 documentation

# delete_repository method definition

def delete_repository(
    self,
    *,
    repositoryName: str,
    registryId: str = ...,
    force: bool = ...,
) -> DeleteRepositoryResponseTypeDef:  # (1)
    ...
  1. See DeleteRepositoryResponseTypeDef 
# delete_repository method usage example with argument unpacking

kwargs: DeleteRepositoryRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.delete_repository(**kwargs)
  1. See DeleteRepositoryRequestRequestTypeDef

delete_repository_policy#

Deletes the repository policy that's associated with the specified repository.

Type annotations and code completion for boto3.client("ecr-public").delete_repository_policy method. boto3 documentation

# delete_repository_policy method definition

def delete_repository_policy(
    self,
    *,
    repositoryName: str,
    registryId: str = ...,
) -> DeleteRepositoryPolicyResponseTypeDef:  # (1)
    ...
  1. See DeleteRepositoryPolicyResponseTypeDef 
# delete_repository_policy method usage example with argument unpacking

kwargs: DeleteRepositoryPolicyRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.delete_repository_policy(**kwargs)
  1. See DeleteRepositoryPolicyRequestRequestTypeDef

describe_image_tags#

Returns the image tag details for a repository in a public registry.

Type annotations and code completion for boto3.client("ecr-public").describe_image_tags method. boto3 documentation

# describe_image_tags method definition

def describe_image_tags(
    self,
    *,
    repositoryName: str,
    registryId: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeImageTagsResponseTypeDef:  # (1)
    ...
  1. See DescribeImageTagsResponseTypeDef 
# describe_image_tags method usage example with argument unpacking

kwargs: DescribeImageTagsRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.describe_image_tags(**kwargs)
  1. See DescribeImageTagsRequestRequestTypeDef

describe_images#

Returns metadata that's related to the images in a repository in a public registry.

Type annotations and code completion for boto3.client("ecr-public").describe_images method. boto3 documentation

# describe_images method definition

def describe_images(
    self,
    *,
    repositoryName: str,
    registryId: str = ...,
    imageIds: Sequence[ImageIdentifierTypeDef] = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeImagesResponseTypeDef:  # (2)
    ...
  1. See ImageIdentifierTypeDef
  2. See DescribeImagesResponseTypeDef 
# describe_images method usage example with argument unpacking

kwargs: DescribeImagesRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.describe_images(**kwargs)
  1. See DescribeImagesRequestRequestTypeDef

describe_registries#

Returns details for a public registry.

Type annotations and code completion for boto3.client("ecr-public").describe_registries method. boto3 documentation

# describe_registries method definition

def describe_registries(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeRegistriesResponseTypeDef:  # (1)
    ...
  1. See DescribeRegistriesResponseTypeDef 
# describe_registries method usage example with argument unpacking

kwargs: DescribeRegistriesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.describe_registries(**kwargs)
  1. See DescribeRegistriesRequestRequestTypeDef

describe_repositories#

Describes repositories that are in a public registry.

Type annotations and code completion for boto3.client("ecr-public").describe_repositories method. boto3 documentation

# describe_repositories method definition

def describe_repositories(
    self,
    *,
    registryId: str = ...,
    repositoryNames: Sequence[str] = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeRepositoriesResponseTypeDef:  # (1)
    ...
  1. See DescribeRepositoriesResponseTypeDef 
# describe_repositories method usage example with argument unpacking

kwargs: DescribeRepositoriesRequestRequestTypeDef = {  # (1)
    "registryId": ...,
}

parent.describe_repositories(**kwargs)
  1. See DescribeRepositoriesRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("ecr-public").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_authorization_token#

Retrieves an authorization token.

Type annotations and code completion for boto3.client("ecr-public").get_authorization_token method. boto3 documentation

# get_authorization_token method definition

def get_authorization_token(
    self,
) -> GetAuthorizationTokenResponseTypeDef:  # (1)
    ...
  1. See GetAuthorizationTokenResponseTypeDef

get_registry_catalog_data#

Retrieves catalog metadata for a public registry.

Type annotations and code completion for boto3.client("ecr-public").get_registry_catalog_data method. boto3 documentation

# get_registry_catalog_data method definition

def get_registry_catalog_data(
    self,
) -> GetRegistryCatalogDataResponseTypeDef:  # (1)
    ...
  1. See GetRegistryCatalogDataResponseTypeDef

get_repository_catalog_data#

Retrieve catalog metadata for a repository in a public registry.

Type annotations and code completion for boto3.client("ecr-public").get_repository_catalog_data method. boto3 documentation

# get_repository_catalog_data method definition

def get_repository_catalog_data(
    self,
    *,
    repositoryName: str,
    registryId: str = ...,
) -> GetRepositoryCatalogDataResponseTypeDef:  # (1)
    ...
  1. See GetRepositoryCatalogDataResponseTypeDef 
# get_repository_catalog_data method usage example with argument unpacking

kwargs: GetRepositoryCatalogDataRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.get_repository_catalog_data(**kwargs)
  1. See GetRepositoryCatalogDataRequestRequestTypeDef

get_repository_policy#

Retrieves the repository policy for the specified repository.

Type annotations and code completion for boto3.client("ecr-public").get_repository_policy method. boto3 documentation

# get_repository_policy method definition

def get_repository_policy(
    self,
    *,
    repositoryName: str,
    registryId: str = ...,
) -> GetRepositoryPolicyResponseTypeDef:  # (1)
    ...
  1. See GetRepositoryPolicyResponseTypeDef 
# get_repository_policy method usage example with argument unpacking

kwargs: GetRepositoryPolicyRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.get_repository_policy(**kwargs)
  1. See GetRepositoryPolicyRequestRequestTypeDef

initiate_layer_upload#

Notifies Amazon ECR that you intend to upload an image layer.

Type annotations and code completion for boto3.client("ecr-public").initiate_layer_upload method. boto3 documentation

# initiate_layer_upload method definition

def initiate_layer_upload(
    self,
    *,
    repositoryName: str,
    registryId: str = ...,
) -> InitiateLayerUploadResponseTypeDef:  # (1)
    ...
  1. See InitiateLayerUploadResponseTypeDef 
# initiate_layer_upload method usage example with argument unpacking

kwargs: InitiateLayerUploadRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
}

parent.initiate_layer_upload(**kwargs)
  1. See InitiateLayerUploadRequestRequestTypeDef

list_tags_for_resource#

List the tags for an Amazon ECR Public resource.

Type annotations and code completion for boto3.client("ecr-public").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

put_image#

Creates or updates the image manifest and tags that are associated with an image.

Type annotations and code completion for boto3.client("ecr-public").put_image method. boto3 documentation

# put_image method definition

def put_image(
    self,
    *,
    repositoryName: str,
    imageManifest: str,
    registryId: str = ...,
    imageManifestMediaType: str = ...,
    imageTag: str = ...,
    imageDigest: str = ...,
) -> PutImageResponseTypeDef:  # (1)
    ...
  1. See PutImageResponseTypeDef 
# put_image method usage example with argument unpacking

kwargs: PutImageRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "imageManifest": ...,
}

parent.put_image(**kwargs)
  1. See PutImageRequestRequestTypeDef

put_registry_catalog_data#

Create or update the catalog data for a public registry.

Type annotations and code completion for boto3.client("ecr-public").put_registry_catalog_data method. boto3 documentation

# put_registry_catalog_data method definition

def put_registry_catalog_data(
    self,
    *,
    displayName: str = ...,
) -> PutRegistryCatalogDataResponseTypeDef:  # (1)
    ...
  1. See PutRegistryCatalogDataResponseTypeDef 
# put_registry_catalog_data method usage example with argument unpacking

kwargs: PutRegistryCatalogDataRequestRequestTypeDef = {  # (1)
    "displayName": ...,
}

parent.put_registry_catalog_data(**kwargs)
  1. See PutRegistryCatalogDataRequestRequestTypeDef

put_repository_catalog_data#

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

Type annotations and code completion for boto3.client("ecr-public").put_repository_catalog_data method. boto3 documentation

# put_repository_catalog_data method definition

def put_repository_catalog_data(
    self,
    *,
    repositoryName: str,
    catalogData: RepositoryCatalogDataInputTypeDef,  # (1)
    registryId: str = ...,
) -> PutRepositoryCatalogDataResponseTypeDef:  # (2)
    ...
  1. See RepositoryCatalogDataInputTypeDef
  2. See PutRepositoryCatalogDataResponseTypeDef 
# put_repository_catalog_data method usage example with argument unpacking

kwargs: PutRepositoryCatalogDataRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "catalogData": ...,
}

parent.put_repository_catalog_data(**kwargs)
  1. See PutRepositoryCatalogDataRequestRequestTypeDef

set_repository_policy#

Applies a repository policy to the specified public repository to control access permissions.

Type annotations and code completion for boto3.client("ecr-public").set_repository_policy method. boto3 documentation

# set_repository_policy method definition

def set_repository_policy(
    self,
    *,
    repositoryName: str,
    policyText: str,
    registryId: str = ...,
    force: bool = ...,
) -> SetRepositoryPolicyResponseTypeDef:  # (1)
    ...
  1. See SetRepositoryPolicyResponseTypeDef 
# set_repository_policy method usage example with argument unpacking

kwargs: SetRepositoryPolicyRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "policyText": ...,
}

parent.set_repository_policy(**kwargs)
  1. See SetRepositoryPolicyRequestRequestTypeDef

tag_resource#

Associates the specified tags to a resource with the specified resourceArn.

Type annotations and code completion for boto3.client("ecr-public").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Deletes specified tags from a resource.

Type annotations and code completion for boto3.client("ecr-public").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

upload_layer_part#

Uploads an image layer part to Amazon ECR.

Type annotations and code completion for boto3.client("ecr-public").upload_layer_part method. boto3 documentation

# upload_layer_part method definition

def upload_layer_part(
    self,
    *,
    repositoryName: str,
    uploadId: str,
    partFirstByte: int,
    partLastByte: int,
    layerPartBlob: BlobTypeDef,
    registryId: str = ...,
) -> UploadLayerPartResponseTypeDef:  # (1)
    ...
  1. See UploadLayerPartResponseTypeDef 
# upload_layer_part method usage example with argument unpacking

kwargs: UploadLayerPartRequestRequestTypeDef = {  # (1)
    "repositoryName": ...,
    "uploadId": ...,
    "partFirstByte": ...,
    "partLastByte": ...,
    "layerPartBlob": ...,
}

parent.upload_layer_part(**kwargs)
  1. See UploadLayerPartRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("ecr-public").get_paginator method with overloads.