lib/aws-sdk-ecr/client.rb in aws-sdk-ecr-1.45.0 vs lib/aws-sdk-ecr/client.rb in aws-sdk-ecr-1.46.0

- old
+ new

@@ -348,13 +348,13 @@ # should use the `docker` CLI to pull, tag, and push images. # # </note> # # @option params [String] :registry_id - # The AWS account ID associated with the registry that contains the - # image layers to check. If you do not specify a registry, the default - # registry is assumed. + # The Amazon Web Services account ID associated with the registry that + # contains the image layers to check. If you do not specify a registry, + # the default registry is assumed. # # @option params [required, String] :repository_name # The name of the repository that is associated with the image layers to # check. # @@ -404,13 +404,13 @@ # # You can completely delete an image (and all of its tags) by specifying # the image's digest in your request. # # @option params [String] :registry_id - # The AWS account ID associated with the registry that contains the - # image to delete. If you do not specify a registry, the default - # registry is assumed. + # The Amazon Web Services account ID associated with the registry that + # contains the image to delete. If you do not specify a registry, the + # default registry is assumed. # # @option params [required, String] :repository_name # The repository that contains the image to delete. # # @option params [required, Array<Types::ImageIdentifier>] :image_ids @@ -488,13 +488,13 @@ # # 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. + # The Amazon Web Services account ID associated with the registry that + # contains the images to describe. If you do not specify a registry, the + # default registry is assumed. # # @option params [required, String] :repository_name # The repository that contains the images to describe. # # @option params [required, Array<Types::ImageIdentifier>] :image_ids @@ -597,13 +597,13 @@ # should use the `docker` CLI to pull, tag, and push images. # # </note> # # @option params [String] :registry_id - # The AWS account ID associated with the registry to which to upload - # layers. If you do not specify a registry, the default registry is - # assumed. + # The Amazon Web Services account ID associated with the registry to + # which to upload layers. If you do not specify a registry, the default + # registry is assumed. # # @option params [required, String] :repository_name # The name of the repository to associate with the image layer. # # @option params [required, String] :upload_id @@ -644,11 +644,11 @@ req = build_request(:complete_layer_upload, params) req.send_request(options) end # Creates a repository. For more information, see [Amazon ECR - # Repositories][1] in the *Amazon Elastic Container Registry User + # repositories][1] in the *Amazon Elastic Container Registry User # Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html @@ -747,13 +747,13 @@ end # 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. + # The Amazon Web Services account ID associated with the registry that + # contains the repository. If you do not specify a registry, the default + # registry is assumed. # # @option params [required, String] :repository_name # The name of the repository. # # @return [Types::DeleteLifecyclePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -810,13 +810,13 @@ # 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. + # The Amazon Web Services account ID associated with the registry that + # contains the repository to delete. If you do not specify a registry, + # the default registry is assumed. # # @option params [required, String] :repository_name # The name of the repository to delete. # # @option params [Boolean] :force @@ -877,13 +877,13 @@ # 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. + # The Amazon Web Services 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. # # @option params [required, String] :repository_name # The name of the repository that is associated with the repository # policy to delete. # @@ -932,13 +932,14 @@ end # 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. + # The Amazon Web Services 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. # # @option params [required, String] :repository_name # The repository for the image for which to describe the scan findings. # # @option params [required, Types::ImageIdentifier] :image_id @@ -1031,13 +1032,13 @@ # DescribeImages. # # </note> # # @option params [String] :registry_id - # The AWS account ID associated with the registry that contains the - # repository in which to describe images. If you do not specify a - # registry, the default registry is assumed. + # The Amazon Web Services account ID associated with the registry that + # contains the repository in which to describe images. If you do not + # specify a registry, the default registry is assumed. # # @option params [required, String] :repository_name # The repository that contains the images to describe. # # @option params [Array<Types::ImageIdentifier>] :image_ids @@ -1147,13 +1148,13 @@ end # Describes image repositories in a registry. # # @option params [String] :registry_id - # The AWS account ID associated with the registry that contains the - # repositories to be described. If you do not specify a registry, the - # default registry is assumed. + # The Amazon Web Services account ID associated with the registry that + # contains the repositories to be described. If you do not specify a + # registry, the default registry is assumed. # # @option params [Array<String>] :repository_names # A list of repositories to describe. If this parameter is omitted, then # all repositories in a registry are described. # @@ -1253,23 +1254,23 @@ # 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 + # registry. The 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 + # 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 AuthorizationData objects. If you do not specify a - # registry, the default registry is assumed. + # A list of Amazon Web Services account IDs that are associated with the + # registries for 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; # @@ -1326,13 +1327,13 @@ # should use the `docker` CLI to pull, tag, and push images. # # </note> # # @option params [String] :registry_id - # The AWS account ID associated with the registry that contains the - # image layer to download. If you do not specify a registry, the default - # registry is assumed. + # The Amazon Web Services account ID associated with the registry that + # contains the image layer to download. If you do not specify a + # registry, the default registry is assumed. # # @option params [required, String] :repository_name # The name of the repository that is associated with the image layer to # download. # @@ -1367,13 +1368,13 @@ end # 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. + # The Amazon Web Services account ID associated with the registry that + # contains the repository. If you do not specify a registry, the default + # registry is assumed. # # @option params [required, String] :repository_name # The name of the repository. # # @return [Types::GetLifecyclePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1408,13 +1409,13 @@ # 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. + # The Amazon Web Services account ID associated with the registry that + # contains the repository. If you do not specify a registry, the default + # registry is assumed. # # @option params [required, String] :repository_name # The name of the repository. # # @option params [Array<Types::ImageIdentifier>] :image_ids @@ -1528,13 +1529,13 @@ end # 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. + # The Amazon Web Services account ID associated with the registry that + # contains the repository. If you do not specify a registry, the default + # registry is assumed. # # @option params [required, String] :repository_name # The name of the repository with the policy to retrieve. # # @return [Types::GetRepositoryPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1593,13 +1594,13 @@ # should use the `docker` CLI to pull, tag, and push images. # # </note> # # @option params [String] :registry_id - # The AWS account ID associated with the registry to which you intend to - # upload layers. If you do not specify a registry, the default registry - # is assumed. + # The Amazon Web Services account ID associated with the registry to + # which you intend to upload layers. If you do not specify a registry, + # the default registry is assumed. # # @option params [required, String] :repository_name # The name of the repository to which you intend to upload layers. # # @return [Types::InitiateLayerUploadResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -1636,13 +1637,13 @@ # `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. + # The Amazon Web Services 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. # # @option params [required, String] :repository_name # The repository with image IDs to be listed. # # @option params [String] :next_token @@ -1770,13 +1771,13 @@ # should use the `docker` CLI to pull, tag, and push images. # # </note> # # @option params [String] :registry_id - # The AWS account ID associated with the registry that contains the - # repository in which to put the image. If you do not specify a - # registry, the default registry is assumed. + # The Amazon Web Services account ID associated with the registry that + # contains the repository in which to put the image. If you do not + # specify a registry, the default registry is assumed. # # @option params [required, String] :repository_name # The name of the repository in which to put the image. # # @option params [required, String] :image_manifest @@ -1829,14 +1830,14 @@ end # 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 - # assumed. + # The Amazon Web Services 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 assumed. # # @option params [required, String] :repository_name # The name of the repository in which to update the image scanning # configuration setting. # @@ -1875,21 +1876,22 @@ req = build_request(:put_image_scanning_configuration, params) req.send_request(options) end # Updates the image tag mutability settings for the specified - # repository. For more information, see [Image Tag Mutability][1] in the + # 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 # # @option params [String] :registry_id - # The AWS account ID associated with the registry that contains the - # repository in which to update the image tag mutability settings. If - # you do not specify a registry, the default registry is assumed. + # The Amazon Web Services account ID associated with the registry that + # contains the repository in which to update the image tag mutability + # settings. If you do not specify a registry, the default registry is + # assumed. # # @option params [required, String] :repository_name # The name of the repository in which to update the image tag mutability # settings. # @@ -1927,20 +1929,20 @@ req = build_request(:put_image_tag_mutability, params) req.send_request(options) end # Creates or updates the lifecycle policy for the specified repository. - # For more information, see [Lifecycle Policy Template][1]. + # For more information, see [Lifecycle policy template][1]. # # # # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html # # @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. + # The Amazon Web Services account ID associated with the registry that + # contains the repository. If you do
 not specify a registry, the + # default registry is assumed. # # @option params [required, String] :repository_name # The name of the repository to receive the policy. # # @option params [required, String] :lifecycle_policy_text @@ -1975,14 +1977,14 @@ req.send_request(options) end # Creates or updates the permissions policy for your registry. # - # A registry policy is used to specify permissions for another AWS - # account and is used when configuring cross-account replication. For - # more information, see [Registry permissions][1] in the *Amazon Elastic - # Container Registry User Guide*. + # A registry policy is used to specify permissions for another Amazon + # Web Services account and is used when configuring cross-account + # replication. For more information, see [Registry permissions][1] in + # the *Amazon Elastic Container Registry User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html # @@ -2024,11 +2026,11 @@ # 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][1] in the + # information, see [Using service-linked roles for Amazon ECR][1] in the # *Amazon Elastic Container Registry User Guide*. # # <note markdown="1"> When configuring cross-account replication, the destination account # must grant the source account permission to replicate. This permission # is controlled using a registry permissions policy. For more @@ -2080,27 +2082,27 @@ req.send_request(options) end # 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*. + # policies][1] in the *Amazon Elastic Container Registry User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html # # @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. + # The Amazon Web Services account ID associated with the registry that + # contains the repository. If you do not specify a registry, the default + # registry is assumed. # # @option params [required, String] :repository_name # The name of the repository to receive the policy. # # @option params [required, String] :policy_text # The JSON repository policy text to apply to the repository. For more - # information, see [Amazon ECR Repository Policies][1] in the *Amazon + # information, see [Amazon ECR repository policies][1] in the *Amazon # Elastic Container Registry User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html @@ -2140,22 +2142,22 @@ req = build_request(:set_repository_policy, params) req.send_request(options) end # 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][1] in the *Amazon Elastic Container Registry User Guide*. + # once per 24 hours on an individual image. This limit includes if an + # image was scanned on initial push. For more information, see [Image + # scanning][1] in the *Amazon Elastic Container Registry User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html # # @option params [String] :registry_id - # The AWS account ID associated with the registry that contains the - # repository in which to start an image scan request. If you do not - # specify a registry, the default registry is assumed. + # The Amazon Web Services account ID associated with the registry that + # contains the repository in which to start an image scan request. If + # you do not specify a registry, the default registry is assumed. # # @option params [required, String] :repository_name # The name of the repository that contains the images to scan. # # @option params [required, Types::ImageIdentifier] :image_id @@ -2200,13 +2202,13 @@ # 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. + # The Amazon Web Services account ID associated with the registry that + # contains the repository. If you do not specify a registry, the default + # registry is assumed. # # @option params [required, String] :repository_name # The name of the repository to be evaluated. # # @option params [String] :lifecycle_policy_text @@ -2321,13 +2323,13 @@ # should use the `docker` CLI to pull, tag, and push images. # # </note> # # @option params [String] :registry_id - # The AWS account ID associated with the registry to which you are - # uploading layer parts. If you do not specify a registry, the default - # registry is assumed. + # The Amazon Web Services account ID associated with the registry to + # which you are uploading layer parts. If you do not specify a registry, + # the default registry is assumed. # # @option params [required, String] :repository_name # The name of the repository to which you are uploading layer parts. # # @option params [required, String] :upload_id @@ -2390,10 +2392,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-ecr' - context[:gem_version] = '1.45.0' + context[:gem_version] = '1.46.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #