aws-sdk-ecrpublic 1.12.0 → 1.14.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
30
30
  require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
32
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
33
- require 'aws-sdk-core/plugins/signature_v4.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
34
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
35
35
 
36
36
  Aws::Plugins::GlobalConfiguration.add_identifier(:ecrpublic)
@@ -79,8 +79,9 @@ module Aws::ECRPublic
79
79
  add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
80
  add_plugin(Aws::Plugins::DefaultsMode)
81
81
  add_plugin(Aws::Plugins::RecursionDetection)
82
- add_plugin(Aws::Plugins::SignatureV4)
82
+ add_plugin(Aws::Plugins::Sign)
83
83
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
84
+ add_plugin(Aws::ECRPublic::Plugins::Endpoints)
84
85
 
85
86
  # @overload initialize(options)
86
87
  # @param [Hash] options
@@ -297,6 +298,19 @@ module Aws::ECRPublic
297
298
  # ** Please note ** When response stubbing is enabled, no HTTP
298
299
  # requests are made, and retries are disabled.
299
300
  #
301
+ # @option options [Aws::TokenProvider] :token_provider
302
+ # A Bearer Token Provider. This can be an instance of any one of the
303
+ # following classes:
304
+ #
305
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
306
+ # tokens.
307
+ #
308
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
309
+ # access token generated from `aws login`.
310
+ #
311
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
312
+ # will be used to search for tokens configured for your profile in shared configuration files.
313
+ #
300
314
  # @option options [Boolean] :use_dualstack_endpoint
301
315
  # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
302
316
  # will be used if available.
@@ -310,6 +324,9 @@ module Aws::ECRPublic
310
324
  # When `true`, request parameters are validated before
311
325
  # sending the request.
312
326
  #
327
+ # @option options [Aws::ECRPublic::EndpointProvider] :endpoint_provider
328
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ECRPublic::EndpointParameters`
329
+ #
313
330
  # @option options [URI::HTTP,String] :http_proxy A proxy to send
314
331
  # requests through. Formatted like 'http://proxy.com:123'.
315
332
  #
@@ -361,7 +378,7 @@ module Aws::ECRPublic
361
378
 
362
379
  # @!group API Operations
363
380
 
364
- # Checks the availability of one or more image layers within a
381
+ # Checks the availability of one or more image layers that are within a
365
382
  # repository in a public registry. When an image is pushed to a
366
383
  # repository, each image layer is checked to verify if it has been
367
384
  # uploaded before. If it has been uploaded, then the image layer is
@@ -374,12 +391,12 @@ module Aws::ECRPublic
374
391
  # </note>
375
392
  #
376
393
  # @option params [String] :registry_id
377
- # The AWS account ID associated with the public registry that contains
378
- # the image layers to check. If you do not specify a registry, the
379
- # default public registry is assumed.
394
+ # The Amazon Web Services account ID, or registry alias, associated with
395
+ # the public registry that contains the image layers to check. If you do
396
+ # not specify a registry, the default public registry is assumed.
380
397
  #
381
398
  # @option params [required, String] :repository_name
382
- # The name of the repository that is associated with the image layers to
399
+ # The name of the repository that's associated with the image layers to
383
400
  # check.
384
401
  #
385
402
  # @option params [required, Array<String>] :layer_digests
@@ -419,8 +436,8 @@ module Aws::ECRPublic
419
436
  req.send_request(options)
420
437
  end
421
438
 
422
- # Deletes a list of specified images within a repository in a public
423
- # registry. Images are specified with either an `imageTag` or
439
+ # Deletes a list of specified images that are within a repository in a
440
+ # public registry. Images are specified with either an `imageTag` or
424
441
  # `imageDigest`.
425
442
  #
426
443
  # You can remove a tag from an image by specifying the image's tag in
@@ -428,12 +445,12 @@ module Aws::ECRPublic
428
445
  # deleted from your repository.
429
446
  #
430
447
  # You can completely delete an image (and all of its tags) by specifying
431
- # the image's digest in your request.
448
+ # the digest of the image in your request.
432
449
  #
433
450
  # @option params [String] :registry_id
434
- # The AWS account ID associated with the registry that contains the
435
- # image to delete. If you do not specify a registry, the default public
436
- # registry is assumed.
451
+ # The Amazon Web Services account ID that's associated with the
452
+ # registry that contains the image to delete. If you do not specify a
453
+ # registry, the default public registry is assumed.
437
454
  #
438
455
  # @option params [required, String] :repository_name
439
456
  # The repository in a public registry that contains the image to delete.
@@ -481,13 +498,13 @@ module Aws::ECRPublic
481
498
  req.send_request(options)
482
499
  end
483
500
 
484
- # Informs Amazon ECR that the image layer upload has completed for a
501
+ # Informs Amazon ECR that the image layer upload is complete for a
485
502
  # specified public registry, repository name, and upload ID. You can
486
503
  # optionally provide a `sha256` digest of the image layer for data
487
504
  # validation purposes.
488
505
  #
489
506
  # When an image is pushed, the CompleteLayerUpload API is called once
490
- # per each new image layer to verify that the upload has completed.
507
+ # for each new image layer to verify that the upload is complete.
491
508
  #
492
509
  # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
493
510
  # used by customers for pulling and pushing images. In most cases, you
@@ -496,9 +513,9 @@ module Aws::ECRPublic
496
513
  # </note>
497
514
  #
498
515
  # @option params [String] :registry_id
499
- # The AWS account ID associated with the registry to which to upload
500
- # layers. If you do not specify a registry, the default public registry
501
- # is assumed.
516
+ # The Amazon Web Services account ID, or registry alias, associated with
517
+ # the registry where layers are uploaded. If you do not specify a
518
+ # registry, the default public registry is assumed.
502
519
  #
503
520
  # @option params [required, String] :repository_name
504
521
  # The name of the repository in a public registry to associate with the
@@ -553,9 +570,9 @@ module Aws::ECRPublic
553
570
  #
554
571
  # @option params [required, String] :repository_name
555
572
  # The name to use for the repository. This appears publicly in the
556
- # Amazon ECR Public Gallery. The repository name may be specified on its
557
- # own (such as `nginx-web-app`) or it can be prepended with a namespace
558
- # to group the repository into a category (such as
573
+ # Amazon ECR Public Gallery. The repository name can be specified on its
574
+ # own (for example `nginx-web-app`) or prepended with a namespace to
575
+ # group the repository into a category (for example
559
576
  # `project-a/nginx-web-app`).
560
577
  #
561
578
  # @option params [Types::RepositoryCatalogDataInput] :catalog_data
@@ -563,11 +580,11 @@ module Aws::ECRPublic
563
580
  # Amazon ECR Public Gallery.
564
581
  #
565
582
  # @option params [Array<Types::Tag>] :tags
566
- # The metadata that you apply to the repository to help you categorize
567
- # and organize them. Each tag consists of a key and an optional value,
568
- # both of which you define. Tag keys can have a maximum character length
569
- # of 128 characters, and tag values can have a maximum length of 256
570
- # characters.
583
+ # The metadata that you apply to each repository to help categorize and
584
+ # organize your repositories. Each tag consists of a key and an optional
585
+ # value. You define both of them. Tag keys can have a maximum character
586
+ # length of 128 characters, and tag values can have a maximum length of
587
+ # 256 characters.
571
588
  #
572
589
  # @return [Types::CreateRepositoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
573
590
  #
@@ -621,20 +638,22 @@ module Aws::ECRPublic
621
638
  end
622
639
 
623
640
  # Deletes a repository in a public registry. If the repository contains
624
- # images, you must either delete all images in the repository or use the
625
- # `force` option which deletes all images on your behalf before deleting
626
- # the repository.
641
+ # images, you must either manually delete all images in the repository
642
+ # or use the `force` option. This option deletes all images on your
643
+ # behalf before deleting the repository.
627
644
  #
628
645
  # @option params [String] :registry_id
629
- # The AWS account ID associated with the public registry that contains
630
- # the repository to delete. If you do not specify a registry, the
631
- # default public registry is assumed.
646
+ # The Amazon Web Services account ID that's associated with the public
647
+ # registry that contains the repository to delete. If you do not specify
648
+ # a registry, the default public registry is assumed.
632
649
  #
633
650
  # @option params [required, String] :repository_name
634
651
  # The name of the repository to delete.
635
652
  #
636
653
  # @option params [Boolean] :force
637
- # If a repository contains images, forces the deletion.
654
+ # The force option can be used to delete a repository that contains
655
+ # images. If the force option is not used, the repository must be empty
656
+ # prior to deletion.
638
657
  #
639
658
  # @return [Types::DeleteRepositoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
640
659
  #
@@ -665,16 +684,16 @@ module Aws::ECRPublic
665
684
  req.send_request(options)
666
685
  end
667
686
 
668
- # Deletes the repository policy associated with the specified
687
+ # Deletes the repository policy that's associated with the specified
669
688
  # repository.
670
689
  #
671
690
  # @option params [String] :registry_id
672
- # The AWS account ID associated with the public registry that contains
673
- # the repository policy to delete. If you do not specify a registry, the
674
- # default public registry is assumed.
691
+ # The Amazon Web Services account ID that's associated with the public
692
+ # registry that contains the repository policy to delete. If you do not
693
+ # specify a registry, the default public registry is assumed.
675
694
  #
676
695
  # @option params [required, String] :repository_name
677
- # The name of the repository that is associated with the repository
696
+ # The name of the repository that's associated with the repository
678
697
  # policy to delete.
679
698
  #
680
699
  # @return [Types::DeleteRepositoryPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -708,32 +727,32 @@ module Aws::ECRPublic
708
727
  # Returns the image tag details for a repository in a public registry.
709
728
  #
710
729
  # @option params [String] :registry_id
711
- # The AWS account ID associated with the public registry that contains
712
- # the repository in which to describe images. If you do not specify a
713
- # registry, the default public registry is assumed.
730
+ # The Amazon Web Services account ID that's associated with the public
731
+ # registry that contains the repository where images are described. If
732
+ # you do not specify a registry, the default public registry is assumed.
714
733
  #
715
734
  # @option params [required, String] :repository_name
716
735
  # The name of the repository that contains the image tag details to
717
736
  # describe.
718
737
  #
719
738
  # @option params [String] :next_token
720
- # The `nextToken` value returned from a previous paginated
739
+ # The `nextToken` value that's returned from a previous paginated
721
740
  # `DescribeImageTags` request where `maxResults` was used and the
722
741
  # results exceeded the value of that parameter. Pagination continues
723
742
  # from the end of the previous results that returned the `nextToken`
724
- # value. This value is `null` when there are no more results to return.
725
- # This option cannot be used when you specify images with `imageIds`.
743
+ # value. If there are no more results to return, this value is `null`.
744
+ # If you specify images with `imageIds`, you can't use this option.
726
745
  #
727
746
  # @option params [Integer] :max_results
728
- # The maximum number of repository results returned by
747
+ # The maximum number of repository results that's returned by
729
748
  # `DescribeImageTags` in paginated output. When this parameter is used,
730
749
  # `DescribeImageTags` only returns `maxResults` results in a single page
731
- # along with a `nextToken` response element. The remaining results of
732
- # the initial request can be seen by sending another `DescribeImageTags`
750
+ # along with a `nextToken` response element. You can see the remaining
751
+ # results of the initial request by sending another `DescribeImageTags`
733
752
  # request with the returned `nextToken` value. This value can be between
734
- # 1 and 1000. If this parameter is not used, then `DescribeImageTags`
735
- # returns up to 100 results and a `nextToken` value, if applicable. This
736
- # option cannot be used when you specify images with `imageIds`.
753
+ # 1 and 1000. If this parameter isn't used, then `DescribeImageTags`
754
+ # returns up to 100 results and a `nextToken` value, if applicable. If
755
+ # you specify images with `imageIds`, you can't use this option.
737
756
  #
738
757
  # @return [Types::DescribeImageTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
739
758
  #
@@ -772,21 +791,21 @@ module Aws::ECRPublic
772
791
  req.send_request(options)
773
792
  end
774
793
 
775
- # Returns metadata about the images in a repository in a public
776
- # registry.
794
+ # Returns metadata that's related to the images in a repository in a
795
+ # public registry.
777
796
  #
778
797
  # <note markdown="1"> Beginning with Docker version 1.9, the Docker client compresses image
779
798
  # layers before pushing them to a V2 Docker registry. The output of the
780
- # `docker images` command shows the uncompressed image size, so it may
781
- # return a larger image size than the image sizes returned by
782
- # DescribeImages.
799
+ # `docker images` command shows the uncompressed image size. Therefore,
800
+ # it might return a larger image size than the image sizes that are
801
+ # returned by DescribeImages.
783
802
  #
784
803
  # </note>
785
804
  #
786
805
  # @option params [String] :registry_id
787
- # The AWS account ID associated with the public registry that contains
788
- # the repository in which to describe images. If you do not specify a
789
- # registry, the default public registry is assumed.
806
+ # The Amazon Web Services account ID that's associated with the public
807
+ # registry that contains the repository where images are described. If
808
+ # you do not specify a registry, the default public registry is assumed.
790
809
  #
791
810
  # @option params [required, String] :repository_name
792
811
  # The repository that contains the images to describe.
@@ -795,23 +814,23 @@ module Aws::ECRPublic
795
814
  # The list of image IDs for the requested repository.
796
815
  #
797
816
  # @option params [String] :next_token
798
- # The `nextToken` value returned from a previous paginated
817
+ # The `nextToken` value that's returned from a previous paginated
799
818
  # `DescribeImages` request where `maxResults` was used and the results
800
819
  # exceeded the value of that parameter. Pagination continues from the
801
- # end of the previous results that returned the `nextToken` value. This
802
- # value is `null` when there are no more results to return. This option
803
- # cannot be used when you specify images with `imageIds`.
820
+ # end of the previous results that returned the `nextToken` value. If
821
+ # there are no more results to return, this value is `null`. If you
822
+ # specify images with `imageIds`, you can't use this option.
804
823
  #
805
824
  # @option params [Integer] :max_results
806
- # The maximum number of repository results returned by `DescribeImages`
807
- # in paginated output. When this parameter is used, `DescribeImages`
808
- # only returns `maxResults` results in a single page along with a
809
- # `nextToken` response element. The remaining results of the initial
810
- # request can be seen by sending another `DescribeImages` request with
811
- # the returned `nextToken` value. This value can be between 1 and 1000.
812
- # If this parameter is not used, then `DescribeImages` returns up to 100
813
- # results and a `nextToken` value, if applicable. This option cannot be
814
- # used when you specify images with `imageIds`.
825
+ # The maximum number of repository results that's returned by
826
+ # `DescribeImages` in paginated output. When this parameter is used,
827
+ # `DescribeImages` only returns `maxResults` results in a single page
828
+ # along with a `nextToken` response element. You can see the remaining
829
+ # results of the initial request by sending another `DescribeImages`
830
+ # request with the returned `nextToken` value. This value can be between
831
+ # 1 and 1000. If this parameter isn't used, then `DescribeImages`
832
+ # returns up to 100 results and a `nextToken` value, if applicable. If
833
+ # you specify images with `imageIds`, you can't use this option.
815
834
  #
816
835
  # @return [Types::DescribeImagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
817
836
  #
@@ -861,11 +880,11 @@ module Aws::ECRPublic
861
880
  # Returns details for a public registry.
862
881
  #
863
882
  # @option params [String] :next_token
864
- # The `nextToken` value returned from a previous paginated
883
+ # The `nextToken` value that's returned from a previous paginated
865
884
  # `DescribeRegistries` request where `maxResults` was used and the
866
885
  # results exceeded the value of that parameter. Pagination continues
867
886
  # from the end of the previous results that returned the `nextToken`
868
- # value. This value is `null` when there are no more results to return.
887
+ # value. If there are no more results to return, this value is `null`.
869
888
  #
870
889
  # <note markdown="1"> This token should be treated as an opaque identifier that is only used
871
890
  # to retrieve the next items in a list and not for other programmatic
@@ -874,13 +893,13 @@ module Aws::ECRPublic
874
893
  # </note>
875
894
  #
876
895
  # @option params [Integer] :max_results
877
- # The maximum number of repository results returned by
896
+ # The maximum number of repository results that's returned by
878
897
  # `DescribeRegistries` in paginated output. When this parameter is used,
879
898
  # `DescribeRegistries` only returns `maxResults` results in a single
880
899
  # page along with a `nextToken` response element. The remaining results
881
900
  # of the initial request can be seen by sending another
882
901
  # `DescribeRegistries` request with the returned `nextToken` value. This
883
- # value can be between 1 and 1000. If this parameter is not used, then
902
+ # value can be between 1 and 1000. If this parameter isn't used, then
884
903
  # `DescribeRegistries` returns up to 100 results and a `nextToken`
885
904
  # value, if applicable.
886
905
  #
@@ -921,25 +940,25 @@ module Aws::ECRPublic
921
940
  req.send_request(options)
922
941
  end
923
942
 
924
- # Describes repositories in a public registry.
943
+ # Describes repositories that are in a public registry.
925
944
  #
926
945
  # @option params [String] :registry_id
927
- # The AWS account ID associated with the registry that contains the
928
- # repositories to be described. If you do not specify a registry, the
929
- # default public registry is assumed.
946
+ # The Amazon Web Services account ID that's associated with the
947
+ # registry that contains the repositories to be described. If you do not
948
+ # specify a registry, the default public registry is assumed.
930
949
  #
931
950
  # @option params [Array<String>] :repository_names
932
951
  # A list of repositories to describe. If this parameter is omitted, then
933
952
  # all repositories in a registry are described.
934
953
  #
935
954
  # @option params [String] :next_token
936
- # The `nextToken` value returned from a previous paginated
955
+ # The `nextToken` value that's returned from a previous paginated
937
956
  # `DescribeRepositories` request where `maxResults` was used and the
938
957
  # results exceeded the value of that parameter. Pagination continues
939
958
  # from the end of the previous results that returned the `nextToken`
940
- # value. This value is `null` when there are no more results to return.
941
- # This option cannot be used when you specify repositories with
942
- # `repositoryNames`.
959
+ # value. If there are no more results to return, this value is `null`.
960
+ # If you specify repositories with `repositoryNames`, you can't use
961
+ # this option.
943
962
  #
944
963
  # <note markdown="1"> This token should be treated as an opaque identifier that is only used
945
964
  # to retrieve the next items in a list and not for other programmatic
@@ -948,16 +967,16 @@ module Aws::ECRPublic
948
967
  # </note>
949
968
  #
950
969
  # @option params [Integer] :max_results
951
- # The maximum number of repository results returned by
970
+ # The maximum number of repository results that's returned by
952
971
  # `DescribeRepositories` in paginated output. When this parameter is
953
972
  # used, `DescribeRepositories` only returns `maxResults` results in a
954
- # single page along with a `nextToken` response element. The remaining
955
- # results of the initial request can be seen by sending another
973
+ # single page along with a `nextToken` response element. You can see the
974
+ # remaining results of the initial request by sending another
956
975
  # `DescribeRepositories` request with the returned `nextToken` value.
957
- # This value can be between 1 and 1000. If this parameter is not used,
976
+ # This value can be between 1 and 1000. If this parameter isn't used,
958
977
  # then `DescribeRepositories` returns up to 100 results and a
959
- # `nextToken` value, if applicable. This option cannot be used when you
960
- # specify repositories with `repositoryNames`.
978
+ # `nextToken` value, if applicable. If you specify repositories with
979
+ # `repositoryNames`, you can't use this option.
961
980
  #
962
981
  # @return [Types::DescribeRepositoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
963
982
  #
@@ -995,7 +1014,7 @@ module Aws::ECRPublic
995
1014
  end
996
1015
 
997
1016
  # Retrieves an authorization token. An authorization token represents
998
- # your IAM authentication credentials and can be used to access any
1017
+ # your IAM authentication credentials. You can use it to access any
999
1018
  # Amazon ECR registry that your IAM principal has access to. The
1000
1019
  # authorization token is valid for 12 hours. This API requires the
1001
1020
  # `ecr-public:GetAuthorizationToken` and `sts:GetServiceBearerToken`
@@ -1042,9 +1061,9 @@ module Aws::ECRPublic
1042
1061
  # metadata is displayed publicly in the Amazon ECR Public Gallery.
1043
1062
  #
1044
1063
  # @option params [String] :registry_id
1045
- # The AWS account ID associated with the registry that contains the
1046
- # repositories to be described. If you do not specify a registry, the
1047
- # default public registry is assumed.
1064
+ # The Amazon Web Services account ID that's associated with the
1065
+ # registry that contains the repositories to be described. If you do not
1066
+ # specify a registry, the default public registry is assumed.
1048
1067
  #
1049
1068
  # @option params [required, String] :repository_name
1050
1069
  # The name of the repository to retrieve the catalog metadata for.
@@ -1084,9 +1103,9 @@ module Aws::ECRPublic
1084
1103
  # Retrieves the repository policy for the specified repository.
1085
1104
  #
1086
1105
  # @option params [String] :registry_id
1087
- # The AWS account ID associated with the public registry that contains
1088
- # the repository. If you do not specify a registry, the default public
1089
- # registry is assumed.
1106
+ # The Amazon Web Services account ID that's associated with the public
1107
+ # registry that contains the repository. If you do not specify a
1108
+ # registry, the default public registry is assumed.
1090
1109
  #
1091
1110
  # @option params [required, String] :repository_name
1092
1111
  # The name of the repository with the policy to retrieve.
@@ -1122,9 +1141,9 @@ module Aws::ECRPublic
1122
1141
  # Notifies Amazon ECR that you intend to upload an image layer.
1123
1142
  #
1124
1143
  # When an image is pushed, the InitiateLayerUpload API is called once
1125
- # per image layer that has not already been uploaded. Whether or not an
1126
- # image layer has been uploaded is determined by the
1127
- # BatchCheckLayerAvailability API action.
1144
+ # for each image layer that hasn't already been uploaded. Whether an
1145
+ # image layer uploads is determined by the BatchCheckLayerAvailability
1146
+ # API action.
1128
1147
  #
1129
1148
  # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
1130
1149
  # used by customers for pulling and pushing images. In most cases, you
@@ -1133,12 +1152,12 @@ module Aws::ECRPublic
1133
1152
  # </note>
1134
1153
  #
1135
1154
  # @option params [String] :registry_id
1136
- # The AWS account ID associated with the registry to which you intend to
1137
- # upload layers. If you do not specify a registry, the default public
1138
- # registry is assumed.
1155
+ # The Amazon Web Services account ID, or registry alias, that's
1156
+ # associated with the registry to which you intend to upload layers. If
1157
+ # you do not specify a registry, the default public registry is assumed.
1139
1158
  #
1140
1159
  # @option params [required, String] :repository_name
1141
- # The name of the repository to which you intend to upload layers.
1160
+ # The name of the repository that you want to upload layers to.
1142
1161
  #
1143
1162
  # @return [Types::InitiateLayerUploadResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1144
1163
  #
@@ -1169,8 +1188,8 @@ module Aws::ECRPublic
1169
1188
  # List the tags for an Amazon ECR Public resource.
1170
1189
  #
1171
1190
  # @option params [required, String] :resource_arn
1172
- # The Amazon Resource Name (ARN) that identifies the resource for which
1173
- # to list the tags. Currently, the supported resource is an Amazon ECR
1191
+ # The Amazon Resource Name (ARN) that identifies the resource to list
1192
+ # the tags for. Currently, the supported resource is an Amazon ECR
1174
1193
  # Public repository.
1175
1194
  #
1176
1195
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1198,12 +1217,12 @@ module Aws::ECRPublic
1198
1217
  req.send_request(options)
1199
1218
  end
1200
1219
 
1201
- # Creates or updates the image manifest and tags associated with an
1202
- # image.
1220
+ # Creates or updates the image manifest and tags that are associated
1221
+ # with an image.
1203
1222
  #
1204
1223
  # When an image is pushed and all new image layers have been uploaded,
1205
1224
  # the PutImage API is called once to create or update the image manifest
1206
- # and the tags associated with the image.
1225
+ # and the tags that are associated with the image.
1207
1226
  #
1208
1227
  # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
1209
1228
  # used by customers for pulling and pushing images. In most cases, you
@@ -1212,19 +1231,20 @@ module Aws::ECRPublic
1212
1231
  # </note>
1213
1232
  #
1214
1233
  # @option params [String] :registry_id
1215
- # The AWS account ID associated with the public registry that contains
1216
- # the repository in which to put the image. If you do not specify a
1217
- # registry, the default public registry is assumed.
1234
+ # The Amazon Web Services account ID, or registry alias, that's
1235
+ # associated with the public registry that contains the repository where
1236
+ # the image is put. If you do not specify a registry, the default public
1237
+ # registry is assumed.
1218
1238
  #
1219
1239
  # @option params [required, String] :repository_name
1220
- # The name of the repository in which to put the image.
1240
+ # The name of the repository where the image is put.
1221
1241
  #
1222
1242
  # @option params [required, String] :image_manifest
1223
- # The image manifest corresponding to the image to be uploaded.
1243
+ # The image manifest that corresponds to the image to be uploaded.
1224
1244
  #
1225
1245
  # @option params [String] :image_manifest_media_type
1226
1246
  # The media type of the image manifest. If you push an image manifest
1227
- # that does not contain the `mediaType` field, you must specify the
1247
+ # that doesn't contain the `mediaType` field, you must specify the
1228
1248
  # `imageManifestMediaType` in the request.
1229
1249
  #
1230
1250
  # @option params [String] :image_tag
@@ -1233,7 +1253,7 @@ module Aws::ECRPublic
1233
1253
  # Container Initiative (OCI) formats.
1234
1254
  #
1235
1255
  # @option params [String] :image_digest
1236
- # The image digest of the image manifest corresponding to the image.
1256
+ # The image digest of the image manifest that corresponds to the image.
1237
1257
  #
1238
1258
  # @return [Types::PutImageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1239
1259
  #
@@ -1268,7 +1288,7 @@ module Aws::ECRPublic
1268
1288
  req.send_request(options)
1269
1289
  end
1270
1290
 
1271
- # Create or updates the catalog data for a public registry.
1291
+ # Create or update the catalog data for a public registry.
1272
1292
  #
1273
1293
  # @option params [String] :display_name
1274
1294
  # The display name for a public registry. The display name is shown as
@@ -1306,9 +1326,9 @@ module Aws::ECRPublic
1306
1326
  # registry.
1307
1327
  #
1308
1328
  # @option params [String] :registry_id
1309
- # The AWS account ID associated with the public registry the repository
1310
- # is in. If you do not specify a registry, the default public registry
1311
- # is assumed.
1329
+ # The Amazon Web Services account ID that's associated with the public
1330
+ # registry the repository is in. If you do not specify a registry, the
1331
+ # default public registry is assumed.
1312
1332
  #
1313
1333
  # @option params [required, String] :repository_name
1314
1334
  # The name of the repository to create or update the catalog data for.
@@ -1367,9 +1387,9 @@ module Aws::ECRPublic
1367
1387
  # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html
1368
1388
  #
1369
1389
  # @option params [String] :registry_id
1370
- # The AWS account ID associated with the registry that contains the
1371
- # repository. If you do not specify a registry, the default public
1372
- # registry is assumed.
1390
+ # The Amazon Web Services account ID that's associated with the
1391
+ # registry that contains the repository. If you do not specify a
1392
+ # registry, the default public registry is assumed.
1373
1393
  #
1374
1394
  # @option params [required, String] :repository_name
1375
1395
  # The name of the repository to receive the policy.
@@ -1384,10 +1404,10 @@ module Aws::ECRPublic
1384
1404
  # [1]: https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html
1385
1405
  #
1386
1406
  # @option params [Boolean] :force
1387
- # If the policy you are attempting to set on a repository policy would
1407
+ # If the policy that you want to set on a repository policy would
1388
1408
  # prevent you from setting another policy in the future, you must force
1389
- # the SetRepositoryPolicy operation. This is intended to prevent
1390
- # accidental repository lock outs.
1409
+ # the SetRepositoryPolicy operation. This prevents accidental repository
1410
+ # lockouts.
1391
1411
  #
1392
1412
  # @return [Types::SetRepositoryPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1393
1413
  #
@@ -1420,12 +1440,12 @@ module Aws::ECRPublic
1420
1440
  end
1421
1441
 
1422
1442
  # Associates the specified tags to a resource with the specified
1423
- # `resourceArn`. If existing tags on a resource are not specified in the
1424
- # request parameters, they are not changed. When a resource is deleted,
1425
- # the tags associated with that resource are deleted as well.
1443
+ # `resourceArn`. If existing tags on a resource aren't specified in the
1444
+ # request parameters, they aren't changed. When a resource is deleted,
1445
+ # the tags associated with that resource are also deleted.
1426
1446
  #
1427
1447
  # @option params [required, String] :resource_arn
1428
- # The Amazon Resource Name (ARN) of the resource to which to add tags.
1448
+ # The Amazon Resource Name (ARN) of the resource to add tags to.
1429
1449
  # Currently, the supported resource is an Amazon ECR Public repository.
1430
1450
  #
1431
1451
  # @option params [required, Array<Types::Tag>] :tags
@@ -1459,9 +1479,8 @@ module Aws::ECRPublic
1459
1479
  # Deletes specified tags from a resource.
1460
1480
  #
1461
1481
  # @option params [required, String] :resource_arn
1462
- # The Amazon Resource Name (ARN) of the resource from which to delete
1463
- # tags. Currently, the supported resource is an Amazon ECR Public
1464
- # repository.
1482
+ # The Amazon Resource Name (ARN) of the resource to delete tags from.
1483
+ # Currently, the supported resource is an Amazon ECR Public repository.
1465
1484
  #
1466
1485
  # @option params [required, Array<String>] :tag_keys
1467
1486
  # The keys of the tags to be removed.
@@ -1487,9 +1506,9 @@ module Aws::ECRPublic
1487
1506
  # Uploads an image layer part to Amazon ECR.
1488
1507
  #
1489
1508
  # When an image is pushed, each new image layer is uploaded in parts.
1490
- # The maximum size of each image layer part can be 20971520 bytes (or
1491
- # about 20MB). The UploadLayerPart API is called once per each new image
1492
- # layer part.
1509
+ # The maximum size of each image layer part can be 20971520 bytes (about
1510
+ # 20MB). The UploadLayerPart API is called once for each new image layer
1511
+ # part.
1493
1512
  #
1494
1513
  # <note markdown="1"> This operation is used by the Amazon ECR proxy and is not generally
1495
1514
  # used by customers for pulling and pushing images. In most cases, you
@@ -1498,12 +1517,12 @@ module Aws::ECRPublic
1498
1517
  # </note>
1499
1518
  #
1500
1519
  # @option params [String] :registry_id
1501
- # The AWS account ID associated with the registry to which you are
1502
- # uploading layer parts. If you do not specify a registry, the default
1503
- # public registry is assumed.
1520
+ # The Amazon Web Services account ID, or registry alias, that's
1521
+ # associated with the registry that you're uploading layer parts to. If
1522
+ # you do not specify a registry, the default public registry is assumed.
1504
1523
  #
1505
1524
  # @option params [required, String] :repository_name
1506
- # The name of the repository to which you are uploading layer parts.
1525
+ # The name of the repository that you're uploading layer parts to.
1507
1526
  #
1508
1527
  # @option params [required, String] :upload_id
1509
1528
  # The upload ID from a previous InitiateLayerUpload operation to
@@ -1567,7 +1586,7 @@ module Aws::ECRPublic
1567
1586
  params: params,
1568
1587
  config: config)
1569
1588
  context[:gem_name] = 'aws-sdk-ecrpublic'
1570
- context[:gem_version] = '1.12.0'
1589
+ context[:gem_version] = '1.14.0'
1571
1590
  Seahorse::Client::Request.new(handlers, context)
1572
1591
  end
1573
1592