ECR

public struct ECR

Client object for interacting with AWS ECR service.

Amazon Elastic Container Registry 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.

Member variables

Initialization

  • Initialize the ECR client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Checks the availability of one or more image layers in a repository. 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. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

    Declaration

    Swift

    public func batchCheckLayerAvailability(_ input: BatchCheckLayerAvailabilityRequest) -> EventLoopFuture<BatchCheckLayerAvailabilityResponse>

  • Deletes a list of specified images within a repository. Images are specified with either an imageTag or imageDigest. You can remove a tag from an image by specifying the image’s tag in your request. When you remove the last tag from an image, the image is deleted from your repository. You can completely delete an image (and all of its tags) by specifying the image’s digest in your request.

    Declaration

    Swift

    public func batchDeleteImage(_ input: BatchDeleteImageRequest) -> EventLoopFuture<BatchDeleteImageResponse>

  • Gets detailed information for an image. Images are specified with either an imageTag or imageDigest. When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

    Declaration

    Swift

    public func batchGetImage(_ input: BatchGetImageRequest) -> EventLoopFuture<BatchGetImageResponse>

  • 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. When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

    Declaration

    Swift

    public func completeLayerUpload(_ input: CompleteLayerUploadRequest) -> EventLoopFuture<CompleteLayerUploadResponse>

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

    Declaration

    Swift

    public func createRepository(_ input: CreateRepositoryRequest) -> EventLoopFuture<CreateRepositoryResponse>

  • Deletes the lifecycle policy associated with the specified repository.

    Declaration

    Swift

    public func deleteLifecyclePolicy(_ input: DeleteLifecyclePolicyRequest) -> EventLoopFuture<DeleteLifecyclePolicyResponse>

  • Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force option to delete the repository.

    Declaration

    Swift

    public func deleteRepository(_ input: DeleteRepositoryRequest) -> EventLoopFuture<DeleteRepositoryResponse>

  • Deletes the repository policy associated with the specified repository.

    Declaration

    Swift

    public func deleteRepositoryPolicy(_ input: DeleteRepositoryPolicyRequest) -> EventLoopFuture<DeleteRepositoryPolicyResponse>

  • Returns the scan findings for the specified image.

    Declaration

    Swift

    public func describeImageScanFindings(_ input: DescribeImageScanFindingsRequest) -> EventLoopFuture<DescribeImageScanFindingsResponse>

  • Returns metadata about the images in a repository. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

    Declaration

    Swift

    public func describeImages(_ input: DescribeImagesRequest) -> EventLoopFuture<DescribeImagesResponse>

  • Describes image repositories in a registry.

    Declaration

    Swift

    public func describeRepositories(_ input: DescribeRepositoriesRequest) -> EventLoopFuture<DescribeRepositoriesResponse>

  • 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. The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an get-login-password command that simplifies the login process. For more information, see Registry Authentication in the Amazon Elastic Container Registry User Guide.

    Declaration

    Swift

    public func getAuthorizationToken(_ input: GetAuthorizationTokenRequest) -> EventLoopFuture<GetAuthorizationTokenResponse>

  • 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. When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

    Declaration

    Swift

    public func getDownloadUrlForLayer(_ input: GetDownloadUrlForLayerRequest) -> EventLoopFuture<GetDownloadUrlForLayerResponse>

  • Retrieves the lifecycle policy for the specified repository.

    Declaration

    Swift

    public func getLifecyclePolicy(_ input: GetLifecyclePolicyRequest) -> EventLoopFuture<GetLifecyclePolicyResponse>

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

    Declaration

    Swift

    public func getLifecyclePolicyPreview(_ input: GetLifecyclePolicyPreviewRequest) -> EventLoopFuture<GetLifecyclePolicyPreviewResponse>

  • Retrieves the repository policy for the specified repository.

    Declaration

    Swift

    public func getRepositoryPolicy(_ input: GetRepositoryPolicyRequest) -> EventLoopFuture<GetRepositoryPolicyResponse>

  • Notifies Amazon ECR that you intend to upload an image layer. When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

    Declaration

    Swift

    public func initiateLayerUpload(_ input: InitiateLayerUploadRequest) -> EventLoopFuture<InitiateLayerUploadResponse>

  • Lists all the image IDs for the specified repository. You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

    Declaration

    Swift

    public func listImages(_ input: ListImagesRequest) -> EventLoopFuture<ListImagesResponse>

  • List the tags for an Amazon ECR resource.

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>

  • Creates or updates the image manifest and tags associated with an image. When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

    Declaration

    Swift

    public func putImage(_ input: PutImageRequest) -> EventLoopFuture<PutImageResponse>

  • Updates the image scanning configuration for the specified repository.

    Declaration

    Swift

    public func putImageScanningConfiguration(_ input: PutImageScanningConfigurationRequest) -> EventLoopFuture<PutImageScanningConfigurationResponse>

  • 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.

    Declaration

    Swift

    public func putImageTagMutability(_ input: PutImageTagMutabilityRequest) -> EventLoopFuture<PutImageTagMutabilityResponse>

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

    Declaration

    Swift

    public func putLifecyclePolicy(_ input: PutLifecyclePolicyRequest) -> EventLoopFuture<PutLifecyclePolicyResponse>

  • 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.

    Declaration

    Swift

    public func setRepositoryPolicy(_ input: SetRepositoryPolicyRequest) -> EventLoopFuture<SetRepositoryPolicyResponse>

  • Starts an image vulnerability scan. An image scan can only be started once per day on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image Scanning in the Amazon Elastic Container Registry User Guide.

    Declaration

    Swift

    public func startImageScan(_ input: StartImageScanRequest) -> EventLoopFuture<StartImageScanResponse>

  • 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.

    Declaration

    Swift

    public func startLifecyclePolicyPreview(_ input: StartLifecyclePolicyPreviewRequest) -> EventLoopFuture<StartLifecyclePolicyPreviewResponse>

  • 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.

    Declaration

    Swift

    public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>

  • Deletes specified tags from a resource.

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

  • Uploads an image layer part to Amazon ECR. When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part. This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

    Declaration

    Swift

    public func uploadLayerPart(_ input: UploadLayerPartRequest) -> EventLoopFuture<UploadLayerPartResponse>

Paginators

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum EncryptionType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum FindingSeverity : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ImageActionType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ImageFailureCode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ImageTagMutability : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum LayerAvailability : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum LayerFailureCode : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum LifecyclePolicyPreviewStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ScanStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum TagStatus : String, CustomStringConvertible, Codable