ECRPublicClient#
Auto-generated documentation for ECRPublic type annotations stubs module types-aiobotocore-ecr-public.
ECRPublicClient#
Type annotations and code completion for session.create_client("ecr-public")
boto3 documentation
ECRPublicClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_ecr_public.client import ECRPublicClient
session = get_session()
async with session.create_client("ecr-public") as client:
client: ECRPublicClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("ecr-public").exceptions
structure.
ECRPublicClient.exceptions usage example
async with session.create_client("ecr-public") as client:
try:
do_something(client)
except (
client.ClientError,
client.EmptyUploadException,
client.ImageAlreadyExistsException,
client.ImageDigestDoesNotMatchException,
client.ImageNotFoundException,
client.ImageTagAlreadyExistsException,
client.InvalidLayerException,
client.InvalidLayerPartException,
client.InvalidParameterException,
client.InvalidTagParameterException,
client.LayerAlreadyExistsException,
client.LayerPartTooSmallException,
client.LayersNotFoundException,
client.LimitExceededException,
client.ReferencedImagesNotFoundException,
client.RegistryNotFoundException,
client.RepositoryAlreadyExistsException,
client.RepositoryCatalogDataNotFoundException,
client.RepositoryNotEmptyException,
client.RepositoryNotFoundException,
client.RepositoryPolicyNotFoundException,
client.ServerException,
client.TooManyTagsException,
client.UnsupportedCommandException,
client.UploadNotFoundException,
) as e:
print(e)
ECRPublicClient usage type checking example
from types_aiobotocore_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 session.create_client("ecr-public").batch_check_layer_availability
method.
boto3 documentation
# batch_check_layer_availability method definition
await 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 session.create_client("ecr-public").batch_delete_image
method.
boto3 documentation
# batch_delete_image method definition
await 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 session.create_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 session.create_client("ecr-public").close
method.
boto3 documentation
# close method definition
await 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 session.create_client("ecr-public").complete_layer_upload
method.
boto3 documentation
# complete_layer_upload method definition
await 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 session.create_client("ecr-public").create_repository
method.
boto3 documentation
# create_repository method definition
await 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 session.create_client("ecr-public").delete_repository
method.
boto3 documentation
# delete_repository method definition
await 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 session.create_client("ecr-public").delete_repository_policy
method.
boto3 documentation
# delete_repository_policy method definition
await def delete_repository_policy(
self,
*,
repositoryName: str,
registryId: str = ...,
) -> DeleteRepositoryPolicyResponseTypeDef: # (1)
...
# delete_repository_policy method usage example with argument unpacking
kwargs: DeleteRepositoryPolicyRequestRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.delete_repository_policy(**kwargs)
describe_image_tags#
Returns the image tag details for a repository in a public registry.
Type annotations and code completion for session.create_client("ecr-public").describe_image_tags
method.
boto3 documentation
# describe_image_tags method definition
await def describe_image_tags(
self,
*,
repositoryName: str,
registryId: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeImageTagsResponseTypeDef: # (1)
...
# describe_image_tags method usage example with argument unpacking
kwargs: DescribeImageTagsRequestRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.describe_image_tags(**kwargs)
describe_images#
Returns metadata that's related to the images in a repository in a public registry.
Type annotations and code completion for session.create_client("ecr-public").describe_images
method.
boto3 documentation
# describe_images method definition
await def describe_images(
self,
*,
repositoryName: str,
registryId: str = ...,
imageIds: Sequence[ImageIdentifierTypeDef] = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeImagesResponseTypeDef: # (2)
...
# describe_images method usage example with argument unpacking
kwargs: DescribeImagesRequestRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.describe_images(**kwargs)
describe_registries#
Returns details for a public registry.
Type annotations and code completion for session.create_client("ecr-public").describe_registries
method.
boto3 documentation
# describe_registries method definition
await def describe_registries(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeRegistriesResponseTypeDef: # (1)
...
# describe_registries method usage example with argument unpacking
kwargs: DescribeRegistriesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.describe_registries(**kwargs)
describe_repositories#
Describes repositories that are in a public registry.
Type annotations and code completion for session.create_client("ecr-public").describe_repositories
method.
boto3 documentation
# describe_repositories method definition
await def describe_repositories(
self,
*,
registryId: str = ...,
repositoryNames: Sequence[str] = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeRepositoriesResponseTypeDef: # (1)
...
# describe_repositories method usage example with argument unpacking
kwargs: DescribeRepositoriesRequestRequestTypeDef = { # (1)
"registryId": ...,
}
parent.describe_repositories(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("ecr-public").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("ecr-public").get_authorization_token
method.
boto3 documentation
# get_authorization_token method definition
await def get_authorization_token(
self,
) -> GetAuthorizationTokenResponseTypeDef: # (1)
...
get_registry_catalog_data#
Retrieves catalog metadata for a public registry.
Type annotations and code completion for session.create_client("ecr-public").get_registry_catalog_data
method.
boto3 documentation
# get_registry_catalog_data method definition
await def get_registry_catalog_data(
self,
) -> GetRegistryCatalogDataResponseTypeDef: # (1)
...
get_repository_catalog_data#
Retrieve catalog metadata for a repository in a public registry.
Type annotations and code completion for session.create_client("ecr-public").get_repository_catalog_data
method.
boto3 documentation
# get_repository_catalog_data method definition
await def get_repository_catalog_data(
self,
*,
repositoryName: str,
registryId: str = ...,
) -> GetRepositoryCatalogDataResponseTypeDef: # (1)
...
# get_repository_catalog_data method usage example with argument unpacking
kwargs: GetRepositoryCatalogDataRequestRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.get_repository_catalog_data(**kwargs)
get_repository_policy#
Retrieves the repository policy for the specified repository.
Type annotations and code completion for session.create_client("ecr-public").get_repository_policy
method.
boto3 documentation
# get_repository_policy method definition
await def get_repository_policy(
self,
*,
repositoryName: str,
registryId: str = ...,
) -> GetRepositoryPolicyResponseTypeDef: # (1)
...
# get_repository_policy method usage example with argument unpacking
kwargs: GetRepositoryPolicyRequestRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.get_repository_policy(**kwargs)
initiate_layer_upload#
Notifies Amazon ECR that you intend to upload an image layer.
Type annotations and code completion for session.create_client("ecr-public").initiate_layer_upload
method.
boto3 documentation
# initiate_layer_upload method definition
await def initiate_layer_upload(
self,
*,
repositoryName: str,
registryId: str = ...,
) -> InitiateLayerUploadResponseTypeDef: # (1)
...
# initiate_layer_upload method usage example with argument unpacking
kwargs: InitiateLayerUploadRequestRequestTypeDef = { # (1)
"repositoryName": ...,
}
parent.initiate_layer_upload(**kwargs)
list_tags_for_resource#
List the tags for an Amazon ECR Public resource.
Type annotations and code completion for session.create_client("ecr-public").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
put_image#
Creates or updates the image manifest and tags that are associated with an image.
Type annotations and code completion for session.create_client("ecr-public").put_image
method.
boto3 documentation
# put_image method definition
await def put_image(
self,
*,
repositoryName: str,
imageManifest: str,
registryId: str = ...,
imageManifestMediaType: str = ...,
imageTag: str = ...,
imageDigest: str = ...,
) -> PutImageResponseTypeDef: # (1)
...
# put_image method usage example with argument unpacking
kwargs: PutImageRequestRequestTypeDef = { # (1)
"repositoryName": ...,
"imageManifest": ...,
}
parent.put_image(**kwargs)
put_registry_catalog_data#
Create or update the catalog data for a public registry.
Type annotations and code completion for session.create_client("ecr-public").put_registry_catalog_data
method.
boto3 documentation
# put_registry_catalog_data method definition
await def put_registry_catalog_data(
self,
*,
displayName: str = ...,
) -> PutRegistryCatalogDataResponseTypeDef: # (1)
...
# put_registry_catalog_data method usage example with argument unpacking
kwargs: PutRegistryCatalogDataRequestRequestTypeDef = { # (1)
"displayName": ...,
}
parent.put_registry_catalog_data(**kwargs)
put_repository_catalog_data#
Creates or updates the catalog data for a repository in a public registry.
Type annotations and code completion for session.create_client("ecr-public").put_repository_catalog_data
method.
boto3 documentation
# put_repository_catalog_data method definition
await def put_repository_catalog_data(
self,
*,
repositoryName: str,
catalogData: RepositoryCatalogDataInputTypeDef, # (1)
registryId: str = ...,
) -> PutRepositoryCatalogDataResponseTypeDef: # (2)
...
# put_repository_catalog_data method usage example with argument unpacking
kwargs: PutRepositoryCatalogDataRequestRequestTypeDef = { # (1)
"repositoryName": ...,
"catalogData": ...,
}
parent.put_repository_catalog_data(**kwargs)
set_repository_policy#
Applies a repository policy to the specified public repository to control access permissions.
Type annotations and code completion for session.create_client("ecr-public").set_repository_policy
method.
boto3 documentation
# set_repository_policy method definition
await def set_repository_policy(
self,
*,
repositoryName: str,
policyText: str,
registryId: str = ...,
force: bool = ...,
) -> SetRepositoryPolicyResponseTypeDef: # (1)
...
# set_repository_policy method usage example with argument unpacking
kwargs: SetRepositoryPolicyRequestRequestTypeDef = { # (1)
"repositoryName": ...,
"policyText": ...,
}
parent.set_repository_policy(**kwargs)
tag_resource#
Associates the specified tags to a resource with the specified resourceArn
.
Type annotations and code completion for session.create_client("ecr-public").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Deletes specified tags from a resource.
Type annotations and code completion for session.create_client("ecr-public").untag_resource
method.
boto3 documentation
# untag_resource method definition
await 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)
upload_layer_part#
Uploads an image layer part to Amazon ECR.
Type annotations and code completion for session.create_client("ecr-public").upload_layer_part
method.
boto3 documentation
# upload_layer_part method definition
await def upload_layer_part(
self,
*,
repositoryName: str,
uploadId: str,
partFirstByte: int,
partLastByte: int,
layerPartBlob: Union[str, bytes, IO[Any], StreamingBody],
registryId: str = ...,
) -> UploadLayerPartResponseTypeDef: # (1)
...
# upload_layer_part method usage example with argument unpacking
kwargs: UploadLayerPartRequestRequestTypeDef = { # (1)
"repositoryName": ...,
"uploadId": ...,
"partFirstByte": ...,
"partLastByte": ...,
"layerPartBlob": ...,
}
parent.upload_layer_part(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("ecr-public").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> ECRPublicClient:
...
__aexit__#
Type annotations and code completion for session.create_client("ecr-public").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("ecr-public").get_paginator
method with overloads.
client.get_paginator("describe_image_tags")
-> DescribeImageTagsPaginatorclient.get_paginator("describe_images")
-> DescribeImagesPaginatorclient.get_paginator("describe_registries")
-> DescribeRegistriesPaginatorclient.get_paginator("describe_repositories")
-> DescribeRepositoriesPaginator