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)
...
# batch_check_layer_availability method usage example with argument unpacking
kwargs: BatchCheckLayerAvailabilityRequestRequestTypeDef = { # (1)
"repositoryName": ...,
"layerDigests": ...,
}
parent.batch_check_layer_availability(**kwargs)
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)
...
# batch_delete_image method usage example with argument unpacking
kwargs: BatchDeleteImageRequestRequestTypeDef = { # (1)
"repositoryName": ...,
"imageIds": ...,
}
parent.batch_delete_image(**kwargs)
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)
...
# complete_layer_upload method usage example with argument unpacking
kwargs: CompleteLayerUploadRequestRequestTypeDef = { # (1)
"repositoryName": ...,
"uploadId": ...,
"layerDigests": ...,
}
parent.complete_layer_upload(**kwargs)
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)
...
# create_repository method usage example with argument unpacking
kwargs: CreateRepositoryRequestRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.create_repository(**kwargs)
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)
...
# delete_repository method usage example with argument unpacking
kwargs: DeleteRepositoryRequestRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.delete_repository(**kwargs)
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.