Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the force option. This option deletes all images on your behalf before deleting the repository.
Parameters:
-
registry_id
(Optional[RegistryId], default:
None
)
–
The Amazon Web Services account ID that's associated with the public registry that contains the repository to delete. If you do not specify a registry, the default public registry is assumed.
-
repository_name
(RepositoryName)
–
The name of the repository to delete.
-
force
(Optional[ForceFlag], default:
None
)
–
The force option can be used to delete a repository that contains images. If the force option is not used, the repository must be empty prior to deletion.
Raises:
-
InvalidParameterException
–
The specified parameter is invalid. Review the available parameters for the API request.
-
RepositoryNotEmptyException
–
The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.
-
RepositoryNotFoundException
–
The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
-
ServerException
–
These errors are usually caused by a server-side issue.
-
UnsupportedCommandException
–
The action isn't supported in this Region.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_ecr_public/_services/async_ecrpublic.py
| async def delete_repository(
self,
repository_name: "capo_ecr_public.types.repository_name.RepositoryName",
*,
config_overrides: Optional[AsyncECRPUBLICClientConfig] = None,
registry_id: Optional["capo_ecr_public.types.registry_id.RegistryId"] = None,
force: Optional["capo_ecr_public.types.force_flag.ForceFlag"] = None,
) -> "capo_ecr_public.types.delete_repository_response.DeleteRepositoryResponse":
"""<p>Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the <code>force</code> option. This option deletes all images on your behalf before deleting the repository.</p>
Args:
registry_id: <p>The Amazon Web Services account ID that's associated with the public registry that contains the repository to delete. If you do not specify a registry, the default public registry is assumed.</p>
repository_name: <p>The name of the repository to delete.</p>
force: <p> The force option can be used to delete a repository that contains images. If the force option is not used, the repository must be empty prior to deletion.</p>
Raises:
capo_ecr_public.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
capo_ecr_public.errors.repository_not_empty_exception.RepositoryNotEmptyException: <p>The specified repository contains images. To delete a repository that contains images, you must force the deletion with the <code>force</code> parameter.</p>
capo_ecr_public.errors.repository_not_found_exception.RepositoryNotFoundException: <p>The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.</p>
capo_ecr_public.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
capo_ecr_public.errors.unsupported_command_exception.UnsupportedCommandException: <p>The action isn't supported in this Region.</p>
capo_ecr_public.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_ecr_public.types.delete_repository_request.DeleteRepositoryRequest]",
) -> AsyncOperationResponse[
"capo_ecr_public.types.delete_repository_response.DeleteRepositoryResponse"
]:
import capo_ecr_public._operations.spencer_frontend_service.delete_repository
(
output,
http_response,
) = await capo_ecr_public._operations.spencer_frontend_service.delete_repository.async_delete_repository(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteRepository")
)
input_: capo_ecr_public.types.delete_repository_request.DeleteRepositoryRequest = {
"repository_name": repository_name
}
if registry_id is not None:
input_["registry_id"] = registry_id
if force is not None:
input_["force"] = force
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|