lib/aws-sdk-ecr/client.rb in aws-sdk-ecr-1.24.0 vs lib/aws-sdk-ecr/client.rb in aws-sdk-ecr-1.25.0

- old
+ new

@@ -262,13 +262,19 @@ super end # @!group API Operations - # Check the availability of multiple image layers in a specified - # registry and repository. + # 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 is, then the image + # layer is skipped. + # + # When an image is pulled from a repository, each image layer is checked + # once to verify it is available to be pulled. + # # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended # for general use by customers for pulling and pushing images. In most # cases, you should use the `docker` CLI to pull, tag, and push images. # # </note> @@ -317,12 +323,12 @@ def batch_check_layer_availability(params = {}, options = {}) req = build_request(:batch_check_layer_availability, params) req.send_request(options) end - # Deletes a list of specified images within a specified repository. - # Images are specified with either `imageTag` or `imageDigest`. + # 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. # @@ -405,14 +411,16 @@ def batch_delete_image(params = {}, options = {}) req = build_request(:batch_delete_image, params) req.send_request(options) end - # Gets detailed information for specified images within a specified - # repository. Images are specified with either `imageTag` or - # `imageDigest`. + # 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. + # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # images to describe. If you do not specify a registry, the default # registry is assumed. # @@ -508,10 +516,13 @@ # 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. + # # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended # for general use by customers for pulling and pushing images. In most # cases, you should use the `docker` CLI to pull, tag, and push images. # # </note> @@ -561,14 +572,13 @@ def complete_layer_upload(params = {}, options = {}) req = build_request(:complete_layer_upload, params) req.send_request(options) end - # Creates an Amazon Elastic Container Registry (Amazon ECR) repository, - # where users can push and pull Docker images. For more information, see - # [Amazon ECR Repositories][1] in the *Amazon Elastic Container Registry - # User Guide*. + # Creates a repository. For more information, see [Amazon ECR + # Repositories][1] in the *Amazon Elastic Container Registry User + # Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html # @@ -653,11 +663,11 @@ def create_repository(params = {}, options = {}) req = build_request(:create_repository, params) req.send_request(options) end - # Deletes the specified lifecycle policy. + # Deletes the lifecycle policy associated with the specified repository. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository. If you do not specify a registry, the default registry is # assumed. @@ -693,12 +703,13 @@ def delete_lifecycle_policy(params = {}, options = {}) req = build_request(:delete_lifecycle_policy, params) req.send_request(options) end - # Deletes an existing image repository. If a repository contains images, - # you must use the `force` option to delete it. + # 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. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository to delete. If you do not specify a registry, the default # registry is assumed. @@ -758,11 +769,12 @@ def delete_repository(params = {}, options = {}) req = build_request(:delete_repository, params) req.send_request(options) end - # Deletes the repository policy from a specified repository. + # Deletes the repository policy associated with the specified + # repository. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository policy to delete. If you do not specify a registry, the # default registry is assumed. @@ -813,11 +825,11 @@ def delete_repository_policy(params = {}, options = {}) req = build_request(:delete_repository_policy, params) req.send_request(options) end - # Describes the image scan findings for the specified image. + # Returns the scan findings for the specified image. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository in which to describe the image scan findings for. If you do # not specify a registry, the default registry is assumed. @@ -897,12 +909,11 @@ def describe_image_scan_findings(params = {}, options = {}) req = build_request(:describe_image_scan_findings, params) req.send_request(options) end - # Returns metadata about the images in a repository, including image - # size, image tags, and creation date. + # Returns metadata about the images in a repository. # # <note markdown="1"> 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 @@ -1090,24 +1101,30 @@ def describe_repositories(params = {}, options = {}) req = build_request(:describe_repositories, params) req.send_request(options) end - # Retrieves a token that is valid for a specified registry for 12 hours. - # This command allows you to use the `docker` CLI to push and pull - # images with Amazon ECR. If you do not specify a registry, the default - # registry is assumed. + # 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 for each registry specified 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 `aws ecr - # get-login` command that simplifies the login process. + # 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][1] in the *Amazon Elastic Container Registry User + # Guide*. # + # + # + # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth + # # @option params [Array<String>] :registry_ids # A list of AWS account IDs that are associated with the registries for - # which to get authorization tokens. If you do not specify a registry, - # the default registry is assumed. + # which to get AuthorizationData objects. If you do not specify a + # registry, the default registry is assumed. # # @return [Types::GetAuthorizationTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetAuthorizationTokenResponse#authorization_data #authorization_data} => Array&lt;Types::AuthorizationData&gt; # @@ -1154,10 +1171,13 @@ # 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. + # # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended # for general use by customers for pulling and pushing images. In most # cases, you should use the `docker` CLI to pull, tag, and push images. # # </note> @@ -1199,11 +1219,11 @@ def get_download_url_for_layer(params = {}, options = {}) req = build_request(:get_download_url_for_layer, params) req.send_request(options) end - # Retrieves the specified lifecycle policy. + # Retrieves the lifecycle policy for the specified repository. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository. If you do not specify a registry, the default registry is # assumed. @@ -1239,12 +1259,12 @@ def get_lifecycle_policy(params = {}, options = {}) req = build_request(:get_lifecycle_policy, params) req.send_request(options) end - # Retrieves the results of the specified lifecycle policy preview - # request. + # Retrieves the results of the lifecycle policy preview request for the + # specified repository. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository. If you do not specify a registry, the default registry is # assumed. @@ -1332,11 +1352,11 @@ def get_lifecycle_policy_preview(params = {}, options = {}) req = build_request(:get_lifecycle_policy_preview, params) req.send_request(options) end - # Retrieves the repository policy for a specified repository. + # Retrieves the repository policy for the specified repository. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository. If you do not specify a registry, the default registry is # assumed. @@ -1386,12 +1406,17 @@ def get_repository_policy(params = {}, options = {}) req = build_request(:get_repository_policy, params) req.send_request(options) end - # Notify Amazon ECR that you intend to upload an image layer. + # 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 an image + # layer has been uploaded before is determined by the + # BatchCheckLayerAvailability API action. + # # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended # for general use by customers for pulling and pushing images. In most # cases, you should use the `docker` CLI to pull, tag, and push images. # # </note> @@ -1428,18 +1453,18 @@ def initiate_layer_upload(params = {}, options = {}) req = build_request(:initiate_layer_upload, params) req.send_request(options) end - # Lists all the image IDs for a given repository. + # Lists all the image IDs for the specified repository. # - # You can filter images based on whether or not they are tagged by - # setting the `tagStatus` parameter to `TAGGED` or `UNTAGGED`. 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. + # 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. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository in which to list images. If you do not specify a registry, # the default registry is assumed. @@ -1559,10 +1584,14 @@ end # 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 tags associated with the image. + # # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended # for general use by customers for pulling and pushing images. In most # cases, you should use the `docker` CLI to pull, tag, and push images. # # </note> @@ -1610,11 +1639,11 @@ def put_image(params = {}, options = {}) req = build_request(:put_image, params) req.send_request(options) end - # Updates the image scanning configuration for a repository. + # Updates the image scanning configuration for the specified repository. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository in which to update the image scanning configuration # setting. If you do not specify a registry, the default registry is @@ -1658,15 +1687,13 @@ def put_image_scanning_configuration(params = {}, options = {}) req = build_request(:put_image_scanning_configuration, params) req.send_request(options) end - # Updates the image tag mutability settings for a repository. When a - # repository is configured with tag immutability, all image tags within - # the repository will be prevented them from being overwritten. For more - # information, see [Image Tag Mutability][1] in the *Amazon Elastic - # Container Registry User Guide*. + # Updates the image tag mutability settings for the specified + # repository. For more information, see [Image Tag Mutability][1] in the + # *Amazon Elastic Container Registry User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html # @@ -1712,12 +1739,12 @@ def put_image_tag_mutability(params = {}, options = {}) req = build_request(:put_image_tag_mutability, params) req.send_request(options) end - # Creates or updates a lifecycle policy. For information about lifecycle - # policy syntax, see [Lifecycle Policy Template][1]. + # Creates or updates the lifecycle policy for the specified repository. + # For more information, see [Lifecycle Policy Template][1]. # # # # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html # @@ -1759,11 +1786,11 @@ def put_lifecycle_policy(params = {}, options = {}) req = build_request(:put_lifecycle_policy, params) req.send_request(options) end - # Applies a repository policy on a specified repository to control + # Applies a repository policy to the specified repository to control # access permissions. For more information, see [Amazon ECR Repository # Policies][1] in the *Amazon Elastic Container Registry User Guide*. # # # @@ -1876,12 +1903,13 @@ def start_image_scan(params = {}, options = {}) req = build_request(:start_image_scan, params) req.send_request(options) end - # Starts a preview of the specified lifecycle policy. This allows you to - # see the results before creating the lifecycle policy. + # 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. # # @option params [String] :registry_id # The AWS account ID associated with the registry that contains the # repository. If you do not specify a registry, the default registry is # assumed. @@ -1989,10 +2017,15 @@ req.send_request(options) end # 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. + # # <note markdown="1"> This operation is used by the Amazon ECR proxy, and it is not intended # for general use by customers for pulling and pushing images. In most # cases, you should use the `docker` CLI to pull, tag, and push images. # # </note> @@ -2063,10 +2096,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-ecr' - context[:gem_version] = '1.24.0' + context[:gem_version] = '1.25.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #