ecr/aws.sdk.kotlin.services.ecr

Package-level declarations

Types

Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar Docker CLI, or their 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 private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

batchCheckLayerAvailability

inline suspend fun EcrClient.batchCheckLayerAvailability(crossinline block: BatchCheckLayerAvailabilityRequest.Builder.() -> Unit): BatchCheckLayerAvailabilityResponse

Checks the availability of one or more image layers in a repository.

batchDeleteImage

inline suspend fun EcrClient.batchDeleteImage(crossinline block: BatchDeleteImageRequest.Builder.() -> Unit): BatchDeleteImageResponse

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

batchGetImage

inline suspend fun EcrClient.batchGetImage(crossinline block: BatchGetImageRequest.Builder.() -> Unit): BatchGetImageResponse

Gets detailed information for an image. Images are specified with either an imageTag or imageDigest.

batchGetRepositoryScanningConfiguration

inline suspend fun EcrClient.batchGetRepositoryScanningConfiguration(crossinline block: BatchGetRepositoryScanningConfigurationRequest.Builder.() -> Unit): BatchGetRepositoryScanningConfigurationResponse

Gets the scanning configuration for one or more repositories.

completeLayerUpload

inline suspend fun EcrClient.completeLayerUpload(crossinline block: CompleteLayerUploadRequest.Builder.() -> Unit): CompleteLayerUploadResponse

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

createPullThroughCacheRule

inline suspend fun EcrClient.createPullThroughCacheRule(crossinline block: CreatePullThroughCacheRuleRequest.Builder.() -> Unit): CreatePullThroughCacheRuleResponse

Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.

createRepository

inline suspend fun EcrClient.createRepository(crossinline block: CreateRepositoryRequest.Builder.() -> Unit): CreateRepositoryResponse

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

createRepositoryCreationTemplate

inline suspend fun EcrClient.createRepositoryCreationTemplate(crossinline block: CreateRepositoryCreationTemplateRequest.Builder.() -> Unit): CreateRepositoryCreationTemplateResponse

Creates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see Private repository creation templates in the Amazon Elastic Container Registry User Guide.

deleteLifecyclePolicy

inline suspend fun EcrClient.deleteLifecyclePolicy(crossinline block: DeleteLifecyclePolicyRequest.Builder.() -> Unit): DeleteLifecyclePolicyResponse

Deletes the lifecycle policy associated with the specified repository.

deletePullThroughCacheRule

inline suspend fun EcrClient.deletePullThroughCacheRule(crossinline block: DeletePullThroughCacheRuleRequest.Builder.() -> Unit): DeletePullThroughCacheRuleResponse

Deletes a pull through cache rule.

deleteRegistryPolicy

inline suspend fun EcrClient.deleteRegistryPolicy(crossinline block: DeleteRegistryPolicyRequest.Builder.() -> Unit): DeleteRegistryPolicyResponse

Deletes the registry permissions policy.

deleteRepository

inline suspend fun EcrClient.deleteRepository(crossinline block: DeleteRepositoryRequest.Builder.() -> Unit): DeleteRepositoryResponse

Deletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the force option to delete the repository and have Amazon ECR delete all of its contents on your behalf.

deleteRepositoryCreationTemplate

inline suspend fun EcrClient.deleteRepositoryCreationTemplate(crossinline block: DeleteRepositoryCreationTemplateRequest.Builder.() -> Unit): DeleteRepositoryCreationTemplateResponse

Deletes a repository creation template.

deleteRepositoryPolicy

inline suspend fun EcrClient.deleteRepositoryPolicy(crossinline block: DeleteRepositoryPolicyRequest.Builder.() -> Unit): DeleteRepositoryPolicyResponse

Deletes the repository policy associated with the specified repository.

describeImageReplicationStatus

inline suspend fun EcrClient.describeImageReplicationStatus(crossinline block: DescribeImageReplicationStatusRequest.Builder.() -> Unit): DescribeImageReplicationStatusResponse

Returns the replication status for a specified image.

describeImages

inline suspend fun EcrClient.describeImages(crossinline block: DescribeImagesRequest.Builder.() -> Unit): DescribeImagesResponse

Returns metadata about the images in a repository.

describeImageScanFindings

inline suspend fun EcrClient.describeImageScanFindings(crossinline block: DescribeImageScanFindingsRequest.Builder.() -> Unit): DescribeImageScanFindingsResponse

Returns the scan findings for the specified image.

describePullThroughCacheRules

inline suspend fun EcrClient.describePullThroughCacheRules(crossinline block: DescribePullThroughCacheRulesRequest.Builder.() -> Unit): DescribePullThroughCacheRulesResponse

Returns the pull through cache rules for a registry.

describeRegistry

inline suspend fun EcrClient.describeRegistry(crossinline block: DescribeRegistryRequest.Builder.() -> Unit): DescribeRegistryResponse

Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.

describeRepositories

inline suspend fun EcrClient.describeRepositories(crossinline block: DescribeRepositoriesRequest.Builder.() -> Unit): DescribeRepositoriesResponse

Describes image repositories in a registry.

describeRepositoryCreationTemplates

inline suspend fun EcrClient.describeRepositoryCreationTemplates(crossinline block: DescribeRepositoryCreationTemplatesRequest.Builder.() -> Unit): DescribeRepositoryCreationTemplatesResponse

Returns details about the repository creation templates in a registry. The prefixes request parameter can be used to return the details for a specific repository creation template.

getAccountSetting

inline suspend fun EcrClient.getAccountSetting(crossinline block: GetAccountSettingRequest.Builder.() -> Unit): GetAccountSettingResponse

Retrieves the account setting value for the specified setting name.

getAuthorizationToken

inline suspend fun EcrClient.getAuthorizationToken(crossinline block: GetAuthorizationTokenRequest.Builder.() -> Unit): GetAuthorizationTokenResponse

Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.

getDownloadUrlForLayer

inline suspend fun EcrClient.getDownloadUrlForLayer(crossinline block: GetDownloadUrlForLayerRequest.Builder.() -> Unit): GetDownloadUrlForLayerResponse

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.

getLifecyclePolicy

inline suspend fun EcrClient.getLifecyclePolicy(crossinline block: GetLifecyclePolicyRequest.Builder.() -> Unit): GetLifecyclePolicyResponse

Retrieves the lifecycle policy for the specified repository.

getLifecyclePolicyPreview

inline suspend fun EcrClient.getLifecyclePolicyPreview(crossinline block: GetLifecyclePolicyPreviewRequest.Builder.() -> Unit): GetLifecyclePolicyPreviewResponse

Retrieves the results of the lifecycle policy preview request for the specified repository.

getRegistryPolicy

inline suspend fun EcrClient.getRegistryPolicy(crossinline block: GetRegistryPolicyRequest.Builder.() -> Unit): GetRegistryPolicyResponse

Retrieves the permissions policy for a registry.

getRegistryScanningConfiguration

inline suspend fun EcrClient.getRegistryScanningConfiguration(crossinline block: GetRegistryScanningConfigurationRequest.Builder.() -> Unit): GetRegistryScanningConfigurationResponse

Retrieves the scanning configuration for a registry.

getRepositoryPolicy

inline suspend fun EcrClient.getRepositoryPolicy(crossinline block: GetRepositoryPolicyRequest.Builder.() -> Unit): GetRepositoryPolicyResponse

Retrieves the repository policy for the specified repository.

initiateLayerUpload

inline suspend fun EcrClient.initiateLayerUpload(crossinline block: InitiateLayerUploadRequest.Builder.() -> Unit): InitiateLayerUploadResponse

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

listImages

inline suspend fun EcrClient.listImages(crossinline block: ListImagesRequest.Builder.() -> Unit): ListImagesResponse

Lists all the image IDs for the specified repository.

listTagsForResource

inline suspend fun EcrClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List the tags for an Amazon ECR resource.

putAccountSetting

inline suspend fun EcrClient.putAccountSetting(crossinline block: PutAccountSettingRequest.Builder.() -> Unit): PutAccountSettingResponse

Allows you to change the basic scan type version or registry policy scope.

putImage

inline suspend fun EcrClient.putImage(crossinline block: PutImageRequest.Builder.() -> Unit): PutImageResponse

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

putImageScanningConfiguration

inline suspend fun EcrClient.putImageScanningConfiguration(crossinline block: PutImageScanningConfigurationRequest.Builder.() -> Unit): PutImageScanningConfigurationResponse

The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.

putImageTagMutability

inline suspend fun EcrClient.putImageTagMutability(crossinline block: PutImageTagMutabilityRequest.Builder.() -> Unit): PutImageTagMutabilityResponse

Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.

putLifecyclePolicy

inline suspend fun EcrClient.putLifecyclePolicy(crossinline block: PutLifecyclePolicyRequest.Builder.() -> Unit): PutLifecyclePolicyResponse

Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.

putRegistryPolicy

inline suspend fun EcrClient.putRegistryPolicy(crossinline block: PutRegistryPolicyRequest.Builder.() -> Unit): PutRegistryPolicyResponse

Creates or updates the permissions policy for your registry.

putRegistryScanningConfiguration

inline suspend fun EcrClient.putRegistryScanningConfiguration(crossinline block: PutRegistryScanningConfigurationRequest.Builder.() -> Unit): PutRegistryScanningConfigurationResponse

Creates or updates the scanning configuration for your private registry.

putReplicationConfiguration

inline suspend fun EcrClient.putReplicationConfiguration(crossinline block: PutReplicationConfigurationRequest.Builder.() -> Unit): PutReplicationConfigurationResponse

Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide. For more information on the custom role for replication, see Creating an IAM role for replication.

setRepositoryPolicy

inline suspend fun EcrClient.setRepositoryPolicy(crossinline block: SetRepositoryPolicyRequest.Builder.() -> Unit): SetRepositoryPolicyResponse

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

startImageScan

inline suspend fun EcrClient.startImageScan(crossinline block: StartImageScanRequest.Builder.() -> Unit): StartImageScanResponse

Starts a basic image vulnerability scan.

startLifecyclePolicyPreview

inline suspend fun EcrClient.startLifecyclePolicyPreview(crossinline block: StartLifecyclePolicyPreviewRequest.Builder.() -> Unit): StartLifecyclePolicyPreviewResponse

Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.

tagResource

inline suspend fun EcrClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.

untagResource

inline suspend fun EcrClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes specified tags from a resource.

updatePullThroughCacheRule

inline suspend fun EcrClient.updatePullThroughCacheRule(crossinline block: UpdatePullThroughCacheRuleRequest.Builder.() -> Unit): UpdatePullThroughCacheRuleResponse

Updates an existing pull through cache rule.

updateRepositoryCreationTemplate

inline suspend fun EcrClient.updateRepositoryCreationTemplate(crossinline block: UpdateRepositoryCreationTemplateRequest.Builder.() -> Unit): UpdateRepositoryCreationTemplateResponse

Updates an existing repository creation template.

uploadLayerPart

inline suspend fun EcrClient.uploadLayerPart(crossinline block: UploadLayerPartRequest.Builder.() -> Unit): UploadLayerPartResponse

Uploads an image layer part to Amazon ECR.

validatePullThroughCacheRule

inline suspend fun EcrClient.validatePullThroughCacheRule(crossinline block: ValidatePullThroughCacheRuleRequest.Builder.() -> Unit): ValidatePullThroughCacheRuleResponse

Validates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.

withConfig

fun EcrClient.withConfig(block: EcrClient.Config.Builder.() -> Unit): EcrClient

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.