ecrpublic/aws.sdk.kotlin.services.ecrpublic

Package-level declarations

Types

Link copied to clipboard
interface EcrPublicClient : SdkClient

Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both public and private registries to host your container images. You can use the Docker CLI or your preferred client to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports public repositories with this API. For information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API Reference.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun EcrPublicClient.batchCheckLayerAvailability(crossinline block: BatchCheckLayerAvailabilityRequest.Builder.() -> Unit): BatchCheckLayerAvailabilityResponse

Checks the availability of one or more image layers that are within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.

Link copied to clipboard
inline suspend fun EcrPublicClient.batchDeleteImage(crossinline block: BatchDeleteImageRequest.Builder.() -> Unit): BatchDeleteImageResponse

Deletes a list of specified images that are within a repository in a public registry. Images are specified with either an imageTag or imageDigest.

Link copied to clipboard
inline suspend fun EcrPublicClient.completeLayerUpload(crossinline block: CompleteLayerUploadRequest.Builder.() -> Unit): CompleteLayerUploadResponse

Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes.

Link copied to clipboard
inline suspend fun EcrPublicClient.createRepository(crossinline block: CreateRepositoryRequest.Builder.() -> Unit): CreateRepositoryResponse

Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.

Link copied to clipboard
inline suspend fun EcrPublicClient.deleteRepository(crossinline block: DeleteRepositoryRequest.Builder.() -> Unit): DeleteRepositoryResponse

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.

Link copied to clipboard
inline suspend fun EcrPublicClient.deleteRepositoryPolicy(crossinline block: DeleteRepositoryPolicyRequest.Builder.() -> Unit): DeleteRepositoryPolicyResponse

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

Link copied to clipboard
inline suspend fun EcrPublicClient.describeImages(crossinline block: DescribeImagesRequest.Builder.() -> Unit): DescribeImagesResponse

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

Link copied to clipboard
inline suspend fun EcrPublicClient.describeImageTags(crossinline block: DescribeImageTagsRequest.Builder.() -> Unit): DescribeImageTagsResponse

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

Link copied to clipboard
inline suspend fun EcrPublicClient.describeRegistries(crossinline block: DescribeRegistriesRequest.Builder.() -> Unit): DescribeRegistriesResponse

Returns details for a public registry.

Link copied to clipboard
inline suspend fun EcrPublicClient.describeRepositories(crossinline block: DescribeRepositoriesRequest.Builder.() -> Unit): DescribeRepositoriesResponse

Describes repositories that are in a public registry.

Link copied to clipboard
inline suspend fun EcrPublicClient.getAuthorizationToken(crossinline block: GetAuthorizationTokenRequest.Builder.() -> Unit): GetAuthorizationTokenResponse

Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can use it to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions.

Link copied to clipboard
inline suspend fun EcrPublicClient.getRegistryCatalogData(crossinline block: GetRegistryCatalogDataRequest.Builder.() -> Unit): GetRegistryCatalogDataResponse

Retrieves catalog metadata for a public registry.

Link copied to clipboard
inline suspend fun EcrPublicClient.getRepositoryCatalogData(crossinline block: GetRepositoryCatalogDataRequest.Builder.() -> Unit): GetRepositoryCatalogDataResponse

Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.

Link copied to clipboard
inline suspend fun EcrPublicClient.getRepositoryPolicy(crossinline block: GetRepositoryPolicyRequest.Builder.() -> Unit): GetRepositoryPolicyResponse

Retrieves the repository policy for the specified repository.

Link copied to clipboard
inline suspend fun EcrPublicClient.initiateLayerUpload(crossinline block: InitiateLayerUploadRequest.Builder.() -> Unit): InitiateLayerUploadResponse

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

Link copied to clipboard
inline suspend fun EcrPublicClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List the tags for an Amazon ECR Public resource.

Link copied to clipboard
inline suspend fun EcrPublicClient.putImage(crossinline block: PutImageRequest.Builder.() -> Unit): PutImageResponse

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

Link copied to clipboard
inline suspend fun EcrPublicClient.putRegistryCatalogData(crossinline block: PutRegistryCatalogDataRequest.Builder.() -> Unit): PutRegistryCatalogDataResponse

Create or update the catalog data for a public registry.

Link copied to clipboard
inline suspend fun EcrPublicClient.putRepositoryCatalogData(crossinline block: PutRepositoryCatalogDataRequest.Builder.() -> Unit): PutRepositoryCatalogDataResponse

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

Link copied to clipboard
inline suspend fun EcrPublicClient.setRepositoryPolicy(crossinline block: SetRepositoryPolicyRequest.Builder.() -> Unit): SetRepositoryPolicyResponse

Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.

Link copied to clipboard
inline suspend fun EcrPublicClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

Link copied to clipboard
inline suspend fun EcrPublicClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes specified tags from a resource.

Link copied to clipboard
inline suspend fun EcrPublicClient.uploadLayerPart(crossinline block: UploadLayerPartRequest.Builder.() -> Unit): UploadLayerPartResponse

Uploads an image layer part to Amazon ECR.

Link copied to clipboard
fun EcrPublicClient.withConfig(block: EcrPublicClient.Config.Builder.() -> Unit): EcrPublicClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.