@aws-sdk/client-ecr-public 3.295.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist-types/ECRPUBLIC.d.ts +24 -0
  2. package/dist-types/ECRPUBLICClient.d.ts +24 -4
  3. package/dist-types/commands/BatchCheckLayerAvailabilityCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchDeleteImageCommand.d.ts +16 -0
  5. package/dist-types/commands/CompleteLayerUploadCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateRepositoryCommand.d.ts +16 -0
  7. package/dist-types/commands/DeleteRepositoryCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteRepositoryPolicyCommand.d.ts +16 -0
  9. package/dist-types/commands/DescribeImageTagsCommand.d.ts +16 -0
  10. package/dist-types/commands/DescribeImagesCommand.d.ts +16 -0
  11. package/dist-types/commands/DescribeRegistriesCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeRepositoriesCommand.d.ts +16 -0
  13. package/dist-types/commands/GetAuthorizationTokenCommand.d.ts +16 -0
  14. package/dist-types/commands/GetRegistryCatalogDataCommand.d.ts +16 -0
  15. package/dist-types/commands/GetRepositoryCatalogDataCommand.d.ts +16 -0
  16. package/dist-types/commands/GetRepositoryPolicyCommand.d.ts +16 -0
  17. package/dist-types/commands/InitiateLayerUploadCommand.d.ts +16 -0
  18. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  19. package/dist-types/commands/PutImageCommand.d.ts +16 -0
  20. package/dist-types/commands/PutRegistryCatalogDataCommand.d.ts +16 -0
  21. package/dist-types/commands/PutRepositoryCatalogDataCommand.d.ts +16 -0
  22. package/dist-types/commands/SetRepositoryPolicyCommand.d.ts +16 -0
  23. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  25. package/dist-types/commands/UploadLayerPartCommand.d.ts +16 -0
  26. package/dist-types/models/ECRPUBLICServiceException.d.ts +2 -0
  27. package/dist-types/models/models_0.d.ts +190 -0
  28. package/dist-types/pagination/DescribeImageTagsPaginator.d.ts +3 -0
  29. package/dist-types/pagination/DescribeImagesPaginator.d.ts +3 -0
  30. package/dist-types/pagination/DescribeRegistriesPaginator.d.ts +3 -0
  31. package/dist-types/pagination/DescribeRepositoriesPaginator.d.ts +3 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/package.json +29 -29
@@ -24,6 +24,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
24
24
  import { UploadLayerPartCommandInput, UploadLayerPartCommandOutput } from "./commands/UploadLayerPartCommand";
25
25
  import { ECRPUBLICClient } from "./ECRPUBLICClient";
26
26
  /**
27
+ * @public
27
28
  * <fullname>Amazon Elastic Container Registry Public</fullname>
28
29
  * <p>Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both
29
30
  * public and private registries to host your container images. You can use the Docker CLI or
@@ -34,6 +35,7 @@ import { ECRPUBLICClient } from "./ECRPUBLICClient";
34
35
  */
35
36
  export declare class ECRPUBLIC extends ECRPUBLICClient {
36
37
  /**
38
+ * @public
37
39
  * <p>Checks the availability of one or more image layers that are within a repository in a
38
40
  * public registry. When an image is pushed to a repository, each image layer is checked to
39
41
  * verify if it has been uploaded before. If it has been uploaded, then the image layer is
@@ -46,6 +48,7 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
46
48
  batchCheckLayerAvailability(args: BatchCheckLayerAvailabilityCommandInput, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void): void;
47
49
  batchCheckLayerAvailability(args: BatchCheckLayerAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void): void;
48
50
  /**
51
+ * @public
49
52
  * <p>Deletes a list of specified images that are within a repository in a public registry.
50
53
  * Images are specified with either an <code>imageTag</code> or
51
54
  * <code>imageDigest</code>.</p>
@@ -58,6 +61,7 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
58
61
  batchDeleteImage(args: BatchDeleteImageCommandInput, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void): void;
59
62
  batchDeleteImage(args: BatchDeleteImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void): void;
60
63
  /**
64
+ * @public
61
65
  * <p>Informs Amazon ECR that the image layer upload is complete for a specified public registry,
62
66
  * repository name, and upload ID. You can optionally provide a <code>sha256</code> digest of
63
67
  * the image layer for data validation purposes.</p>
@@ -71,6 +75,7 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
71
75
  completeLayerUpload(args: CompleteLayerUploadCommandInput, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void): void;
72
76
  completeLayerUpload(args: CompleteLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void): void;
73
77
  /**
78
+ * @public
74
79
  * <p>Creates a repository in a public registry. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html">Amazon ECR
75
80
  * repositories</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
76
81
  */
@@ -78,6 +83,7 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
78
83
  createRepository(args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
79
84
  createRepository(args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
80
85
  /**
86
+ * @public
81
87
  * <p>Deletes a repository in a public registry. If the repository contains images, you must
82
88
  * either manually delete all images in the repository or use the <code>force</code> option.
83
89
  * This option deletes all images on your behalf before deleting the repository.</p>
@@ -86,12 +92,14 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
86
92
  deleteRepository(args: DeleteRepositoryCommandInput, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void): void;
87
93
  deleteRepository(args: DeleteRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void): void;
88
94
  /**
95
+ * @public
89
96
  * <p>Deletes the repository policy that's associated with the specified repository.</p>
90
97
  */
91
98
  deleteRepositoryPolicy(args: DeleteRepositoryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRepositoryPolicyCommandOutput>;
92
99
  deleteRepositoryPolicy(args: DeleteRepositoryPolicyCommandInput, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void): void;
93
100
  deleteRepositoryPolicy(args: DeleteRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void): void;
94
101
  /**
102
+ * @public
95
103
  * <p>Returns metadata that's related to the images in a repository in a public
96
104
  * registry.</p>
97
105
  * <note>
@@ -105,24 +113,28 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
105
113
  describeImages(args: DescribeImagesCommandInput, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void;
106
114
  describeImages(args: DescribeImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void;
107
115
  /**
116
+ * @public
108
117
  * <p>Returns the image tag details for a repository in a public registry.</p>
109
118
  */
110
119
  describeImageTags(args: DescribeImageTagsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeImageTagsCommandOutput>;
111
120
  describeImageTags(args: DescribeImageTagsCommandInput, cb: (err: any, data?: DescribeImageTagsCommandOutput) => void): void;
112
121
  describeImageTags(args: DescribeImageTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageTagsCommandOutput) => void): void;
113
122
  /**
123
+ * @public
114
124
  * <p>Returns details for a public registry.</p>
115
125
  */
116
126
  describeRegistries(args: DescribeRegistriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRegistriesCommandOutput>;
117
127
  describeRegistries(args: DescribeRegistriesCommandInput, cb: (err: any, data?: DescribeRegistriesCommandOutput) => void): void;
118
128
  describeRegistries(args: DescribeRegistriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRegistriesCommandOutput) => void): void;
119
129
  /**
130
+ * @public
120
131
  * <p>Describes repositories that are in a public registry.</p>
121
132
  */
122
133
  describeRepositories(args: DescribeRepositoriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRepositoriesCommandOutput>;
123
134
  describeRepositories(args: DescribeRepositoriesCommandInput, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void): void;
124
135
  describeRepositories(args: DescribeRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void): void;
125
136
  /**
137
+ * @public
126
138
  * <p>Retrieves an authorization token. An authorization token represents your IAM
127
139
  * authentication credentials. You can use it to access any Amazon ECR registry that your IAM
128
140
  * principal has access to. The authorization token is valid for 12 hours. This API requires
@@ -133,12 +145,14 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
133
145
  getAuthorizationToken(args: GetAuthorizationTokenCommandInput, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void): void;
134
146
  getAuthorizationToken(args: GetAuthorizationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void): void;
135
147
  /**
148
+ * @public
136
149
  * <p>Retrieves catalog metadata for a public registry.</p>
137
150
  */
138
151
  getRegistryCatalogData(args: GetRegistryCatalogDataCommandInput, options?: __HttpHandlerOptions): Promise<GetRegistryCatalogDataCommandOutput>;
139
152
  getRegistryCatalogData(args: GetRegistryCatalogDataCommandInput, cb: (err: any, data?: GetRegistryCatalogDataCommandOutput) => void): void;
140
153
  getRegistryCatalogData(args: GetRegistryCatalogDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegistryCatalogDataCommandOutput) => void): void;
141
154
  /**
155
+ * @public
142
156
  * <p>Retrieve catalog metadata for a repository in a public registry. This metadata is
143
157
  * displayed publicly in the Amazon ECR Public Gallery.</p>
144
158
  */
@@ -146,12 +160,14 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
146
160
  getRepositoryCatalogData(args: GetRepositoryCatalogDataCommandInput, cb: (err: any, data?: GetRepositoryCatalogDataCommandOutput) => void): void;
147
161
  getRepositoryCatalogData(args: GetRepositoryCatalogDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryCatalogDataCommandOutput) => void): void;
148
162
  /**
163
+ * @public
149
164
  * <p>Retrieves the repository policy for the specified repository.</p>
150
165
  */
151
166
  getRepositoryPolicy(args: GetRepositoryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetRepositoryPolicyCommandOutput>;
152
167
  getRepositoryPolicy(args: GetRepositoryPolicyCommandInput, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void): void;
153
168
  getRepositoryPolicy(args: GetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void): void;
154
169
  /**
170
+ * @public
155
171
  * <p>Notifies Amazon ECR that you intend to upload an image layer.</p>
156
172
  * <p>When an image is pushed, the InitiateLayerUpload API is called once for each image layer
157
173
  * that hasn't already been uploaded. Whether an image layer uploads is determined by the
@@ -164,12 +180,14 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
164
180
  initiateLayerUpload(args: InitiateLayerUploadCommandInput, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void): void;
165
181
  initiateLayerUpload(args: InitiateLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void): void;
166
182
  /**
183
+ * @public
167
184
  * <p>List the tags for an Amazon ECR Public resource.</p>
168
185
  */
169
186
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
170
187
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
171
188
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
172
189
  /**
190
+ * @public
173
191
  * <p>Creates or updates the image manifest and tags that are associated with an image.</p>
174
192
  * <p>When an image is pushed and all new image layers have been uploaded, the PutImage API is
175
193
  * called once to create or update the image manifest and the tags that are associated with
@@ -183,18 +201,21 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
183
201
  putImage(args: PutImageCommandInput, cb: (err: any, data?: PutImageCommandOutput) => void): void;
184
202
  putImage(args: PutImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageCommandOutput) => void): void;
185
203
  /**
204
+ * @public
186
205
  * <p>Create or update the catalog data for a public registry.</p>
187
206
  */
188
207
  putRegistryCatalogData(args: PutRegistryCatalogDataCommandInput, options?: __HttpHandlerOptions): Promise<PutRegistryCatalogDataCommandOutput>;
189
208
  putRegistryCatalogData(args: PutRegistryCatalogDataCommandInput, cb: (err: any, data?: PutRegistryCatalogDataCommandOutput) => void): void;
190
209
  putRegistryCatalogData(args: PutRegistryCatalogDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRegistryCatalogDataCommandOutput) => void): void;
191
210
  /**
211
+ * @public
192
212
  * <p>Creates or updates the catalog data for a repository in a public registry.</p>
193
213
  */
194
214
  putRepositoryCatalogData(args: PutRepositoryCatalogDataCommandInput, options?: __HttpHandlerOptions): Promise<PutRepositoryCatalogDataCommandOutput>;
195
215
  putRepositoryCatalogData(args: PutRepositoryCatalogDataCommandInput, cb: (err: any, data?: PutRepositoryCatalogDataCommandOutput) => void): void;
196
216
  putRepositoryCatalogData(args: PutRepositoryCatalogDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRepositoryCatalogDataCommandOutput) => void): void;
197
217
  /**
218
+ * @public
198
219
  * <p>Applies a repository policy to the specified public repository to control access
199
220
  * permissions. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html">Amazon ECR Repository
200
221
  * Policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
@@ -203,6 +224,7 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
203
224
  setRepositoryPolicy(args: SetRepositoryPolicyCommandInput, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void): void;
204
225
  setRepositoryPolicy(args: SetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void): void;
205
226
  /**
227
+ * @public
206
228
  * <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>.
207
229
  * If existing tags on a resource aren't specified in the request parameters, they aren't
208
230
  * changed. When a resource is deleted, the tags associated with that resource are also
@@ -212,12 +234,14 @@ export declare class ECRPUBLIC extends ECRPUBLICClient {
212
234
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
213
235
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
214
236
  /**
237
+ * @public
215
238
  * <p>Deletes specified tags from a resource.</p>
216
239
  */
217
240
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
218
241
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
219
242
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
220
243
  /**
244
+ * @public
221
245
  * <p>Uploads an image layer part to Amazon ECR.</p>
222
246
  * <p>When an image is pushed, each new image layer is uploaded in parts. The maximum size of
223
247
  * each image layer part can be 20971520 bytes (about 20MB). The UploadLayerPart API is called
@@ -31,15 +31,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
31
31
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
32
32
  import { UploadLayerPartCommandInput, UploadLayerPartCommandOutput } from "./commands/UploadLayerPartCommand";
33
33
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
34
+ /**
35
+ * @public
36
+ */
34
37
  export type ServiceInputTypes = BatchCheckLayerAvailabilityCommandInput | BatchDeleteImageCommandInput | CompleteLayerUploadCommandInput | CreateRepositoryCommandInput | DeleteRepositoryCommandInput | DeleteRepositoryPolicyCommandInput | DescribeImageTagsCommandInput | DescribeImagesCommandInput | DescribeRegistriesCommandInput | DescribeRepositoriesCommandInput | GetAuthorizationTokenCommandInput | GetRegistryCatalogDataCommandInput | GetRepositoryCatalogDataCommandInput | GetRepositoryPolicyCommandInput | InitiateLayerUploadCommandInput | ListTagsForResourceCommandInput | PutImageCommandInput | PutRegistryCatalogDataCommandInput | PutRepositoryCatalogDataCommandInput | SetRepositoryPolicyCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UploadLayerPartCommandInput;
38
+ /**
39
+ * @public
40
+ */
35
41
  export type ServiceOutputTypes = BatchCheckLayerAvailabilityCommandOutput | BatchDeleteImageCommandOutput | CompleteLayerUploadCommandOutput | CreateRepositoryCommandOutput | DeleteRepositoryCommandOutput | DeleteRepositoryPolicyCommandOutput | DescribeImageTagsCommandOutput | DescribeImagesCommandOutput | DescribeRegistriesCommandOutput | DescribeRepositoriesCommandOutput | GetAuthorizationTokenCommandOutput | GetRegistryCatalogDataCommandOutput | GetRepositoryCatalogDataCommandOutput | GetRepositoryPolicyCommandOutput | InitiateLayerUploadCommandOutput | ListTagsForResourceCommandOutput | PutImageCommandOutput | PutRegistryCatalogDataCommandOutput | PutRepositoryCatalogDataCommandOutput | SetRepositoryPolicyCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UploadLayerPartCommandOutput;
42
+ /**
43
+ * @public
44
+ */
36
45
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
37
46
  /**
38
47
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
39
48
  */
40
49
  requestHandler?: __HttpHandler;
41
50
  /**
42
- * A constructor for a class implementing the {@link __Checksum} interface
51
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
43
52
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
44
53
  * @internal
45
54
  */
@@ -129,23 +138,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
129
138
  */
130
139
  logger?: __Logger;
131
140
  /**
132
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
141
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
133
142
  */
134
143
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
135
144
  }
145
+ /**
146
+ * @public
147
+ */
136
148
  type ECRPUBLICClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
137
149
  /**
138
- * The configuration interface of ECRPUBLICClient class constructor that set the region, credentials and other options.
150
+ * @public
151
+ *
152
+ * The configuration interface of ECRPUBLICClient class constructor that set the region, credentials and other options.
139
153
  */
140
154
  export interface ECRPUBLICClientConfig extends ECRPUBLICClientConfigType {
141
155
  }
156
+ /**
157
+ * @public
158
+ */
142
159
  type ECRPUBLICClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
143
160
  /**
144
- * The resolved configuration interface of ECRPUBLICClient class. This is resolved and normalized from the {@link ECRPUBLICClientConfig | constructor configuration interface}.
161
+ * @public
162
+ *
163
+ * The resolved configuration interface of ECRPUBLICClient class. This is resolved and normalized from the {@link ECRPUBLICClientConfig | constructor configuration interface}.
145
164
  */
146
165
  export interface ECRPUBLICClientResolvedConfig extends ECRPUBLICClientResolvedConfigType {
147
166
  }
148
167
  /**
168
+ * @public
149
169
  * <fullname>Amazon Elastic Container Registry Public</fullname>
150
170
  * <p>Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both
151
171
  * public and private registries to host your container images. You can use the Docker CLI or
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ECRPUBLICClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRPUBLICClient";
5
5
  import { BatchCheckLayerAvailabilityRequest, BatchCheckLayerAvailabilityResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchCheckLayerAvailabilityCommand}.
8
10
  */
9
11
  export interface BatchCheckLayerAvailabilityCommandInput extends BatchCheckLayerAvailabilityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchCheckLayerAvailabilityCommand}.
13
17
  */
14
18
  export interface BatchCheckLayerAvailabilityCommandOutput extends BatchCheckLayerAvailabilityResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Checks the availability of one or more image layers that are within a repository in a
18
23
  * public registry. When an image is pushed to a repository, each image layer is checked to
19
24
  * verify if it has been uploaded before. If it has been uploaded, then the image layer is
@@ -31,6 +36,8 @@ export interface BatchCheckLayerAvailabilityCommandOutput extends BatchCheckLaye
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param BatchCheckLayerAvailabilityCommandInput - {@link BatchCheckLayerAvailabilityCommandInput}
40
+ * @returns {@link BatchCheckLayerAvailabilityCommandOutput}
34
41
  * @see {@link BatchCheckLayerAvailabilityCommandInput} for command's `input` shape.
35
42
  * @see {@link BatchCheckLayerAvailabilityCommandOutput} for command's `response` shape.
36
43
  * @see {@link ECRPUBLICClientResolvedConfig | config} for ECRPUBLICClient's `config` shape.
@@ -57,11 +64,20 @@ export interface BatchCheckLayerAvailabilityCommandOutput extends BatchCheckLaye
57
64
  export declare class BatchCheckLayerAvailabilityCommand extends $Command<BatchCheckLayerAvailabilityCommandInput, BatchCheckLayerAvailabilityCommandOutput, ECRPUBLICClientResolvedConfig> {
58
65
  readonly input: BatchCheckLayerAvailabilityCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: BatchCheckLayerAvailabilityCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRPUBLICClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchCheckLayerAvailabilityCommandInput, BatchCheckLayerAvailabilityCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ECRPUBLICClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRPUBLICClient";
5
5
  import { BatchDeleteImageRequest, BatchDeleteImageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link BatchDeleteImageCommand}.
8
10
  */
9
11
  export interface BatchDeleteImageCommandInput extends BatchDeleteImageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link BatchDeleteImageCommand}.
13
17
  */
14
18
  export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a list of specified images that are within a repository in a public registry.
18
23
  * Images are specified with either an <code>imageTag</code> or
19
24
  * <code>imageDigest</code>.</p>
@@ -31,6 +36,8 @@ export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse,
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param BatchDeleteImageCommandInput - {@link BatchDeleteImageCommandInput}
40
+ * @returns {@link BatchDeleteImageCommandOutput}
34
41
  * @see {@link BatchDeleteImageCommandInput} for command's `input` shape.
35
42
  * @see {@link BatchDeleteImageCommandOutput} for command's `response` shape.
36
43
  * @see {@link ECRPUBLICClientResolvedConfig | config} for ECRPUBLICClient's `config` shape.
@@ -54,11 +61,20 @@ export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse,
54
61
  export declare class BatchDeleteImageCommand extends $Command<BatchDeleteImageCommandInput, BatchDeleteImageCommandOutput, ECRPUBLICClientResolvedConfig> {
55
62
  readonly input: BatchDeleteImageCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: BatchDeleteImageCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRPUBLICClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteImageCommandInput, BatchDeleteImageCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ECRPUBLICClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRPUBLICClient";
5
5
  import { CompleteLayerUploadRequest, CompleteLayerUploadResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CompleteLayerUploadCommand}.
8
10
  */
9
11
  export interface CompleteLayerUploadCommandInput extends CompleteLayerUploadRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CompleteLayerUploadCommand}.
13
17
  */
14
18
  export interface CompleteLayerUploadCommandOutput extends CompleteLayerUploadResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Informs Amazon ECR that the image layer upload is complete for a specified public registry,
18
23
  * repository name, and upload ID. You can optionally provide a <code>sha256</code> digest of
19
24
  * the image layer for data validation purposes.</p>
@@ -32,6 +37,8 @@ export interface CompleteLayerUploadCommandOutput extends CompleteLayerUploadRes
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param CompleteLayerUploadCommandInput - {@link CompleteLayerUploadCommandInput}
41
+ * @returns {@link CompleteLayerUploadCommandOutput}
35
42
  * @see {@link CompleteLayerUploadCommandInput} for command's `input` shape.
36
43
  * @see {@link CompleteLayerUploadCommandOutput} for command's `response` shape.
37
44
  * @see {@link ECRPUBLICClientResolvedConfig | config} for ECRPUBLICClient's `config` shape.
@@ -75,11 +82,20 @@ export interface CompleteLayerUploadCommandOutput extends CompleteLayerUploadRes
75
82
  export declare class CompleteLayerUploadCommand extends $Command<CompleteLayerUploadCommandInput, CompleteLayerUploadCommandOutput, ECRPUBLICClientResolvedConfig> {
76
83
  readonly input: CompleteLayerUploadCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: CompleteLayerUploadCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRPUBLICClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CompleteLayerUploadCommandInput, CompleteLayerUploadCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ECRPUBLICClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRPUBLICClient";
5
5
  import { CreateRepositoryRequest, CreateRepositoryResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateRepositoryCommand}.
8
10
  */
9
11
  export interface CreateRepositoryCommandInput extends CreateRepositoryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateRepositoryCommand}.
13
17
  */
14
18
  export interface CreateRepositoryCommandOutput extends CreateRepositoryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a repository in a public registry. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html">Amazon ECR
18
23
  * repositories</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryResponse,
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateRepositoryCommandInput - {@link CreateRepositoryCommandInput}
35
+ * @returns {@link CreateRepositoryCommandOutput}
29
36
  * @see {@link CreateRepositoryCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateRepositoryCommandOutput} for command's `response` shape.
31
38
  * @see {@link ECRPUBLICClientResolvedConfig | config} for ECRPUBLICClient's `config` shape.
@@ -60,11 +67,20 @@ export interface CreateRepositoryCommandOutput extends CreateRepositoryResponse,
60
67
  export declare class CreateRepositoryCommand extends $Command<CreateRepositoryCommandInput, CreateRepositoryCommandOutput, ECRPUBLICClientResolvedConfig> {
61
68
  readonly input: CreateRepositoryCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: CreateRepositoryCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRPUBLICClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRepositoryCommandInput, CreateRepositoryCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ECRPUBLICClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRPUBLICClient";
5
5
  import { DeleteRepositoryRequest, DeleteRepositoryResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteRepositoryCommand}.
8
10
  */
9
11
  export interface DeleteRepositoryCommandInput extends DeleteRepositoryRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteRepositoryCommand}.
13
17
  */
14
18
  export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a repository in a public registry. If the repository contains images, you must
18
23
  * either manually delete all images in the repository or use the <code>force</code> option.
19
24
  * This option deletes all images on your behalf before deleting the repository.</p>
@@ -27,6 +32,8 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResponse,
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param DeleteRepositoryCommandInput - {@link DeleteRepositoryCommandInput}
36
+ * @returns {@link DeleteRepositoryCommandOutput}
30
37
  * @see {@link DeleteRepositoryCommandInput} for command's `input` shape.
31
38
  * @see {@link DeleteRepositoryCommandOutput} for command's `response` shape.
32
39
  * @see {@link ECRPUBLICClientResolvedConfig | config} for ECRPUBLICClient's `config` shape.
@@ -54,11 +61,20 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResponse,
54
61
  export declare class DeleteRepositoryCommand extends $Command<DeleteRepositoryCommandInput, DeleteRepositoryCommandOutput, ECRPUBLICClientResolvedConfig> {
55
62
  readonly input: DeleteRepositoryCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: DeleteRepositoryCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRPUBLICClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRepositoryCommandInput, DeleteRepositoryCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ECRPUBLICClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRPUBLICClient";
5
5
  import { DeleteRepositoryPolicyRequest, DeleteRepositoryPolicyResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteRepositoryPolicyCommand}.
8
10
  */
9
11
  export interface DeleteRepositoryPolicyCommandInput extends DeleteRepositoryPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteRepositoryPolicyCommand}.
13
17
  */
14
18
  export interface DeleteRepositoryPolicyCommandOutput extends DeleteRepositoryPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the repository policy that's associated with the specified repository.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteRepositoryPolicyCommandOutput extends DeleteRepositoryPol
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteRepositoryPolicyCommandInput - {@link DeleteRepositoryPolicyCommandInput}
34
+ * @returns {@link DeleteRepositoryPolicyCommandOutput}
28
35
  * @see {@link DeleteRepositoryPolicyCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteRepositoryPolicyCommandOutput} for command's `response` shape.
30
37
  * @see {@link ECRPUBLICClientResolvedConfig | config} for ECRPUBLICClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DeleteRepositoryPolicyCommandOutput extends DeleteRepositoryPol
52
59
  export declare class DeleteRepositoryPolicyCommand extends $Command<DeleteRepositoryPolicyCommandInput, DeleteRepositoryPolicyCommandOutput, ECRPUBLICClientResolvedConfig> {
53
60
  readonly input: DeleteRepositoryPolicyCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: DeleteRepositoryPolicyCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRPUBLICClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRepositoryPolicyCommandInput, DeleteRepositoryPolicyCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ECRPUBLICClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRPUBLICClient";
5
5
  import { DescribeImageTagsRequest, DescribeImageTagsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeImageTagsCommand}.
8
10
  */
9
11
  export interface DescribeImageTagsCommandInput extends DescribeImageTagsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeImageTagsCommand}.
13
17
  */
14
18
  export interface DescribeImageTagsCommandOutput extends DescribeImageTagsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the image tag details for a repository in a public registry.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeImageTagsCommandOutput extends DescribeImageTagsRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeImageTagsCommandInput - {@link DescribeImageTagsCommandInput}
34
+ * @returns {@link DescribeImageTagsCommandOutput}
28
35
  * @see {@link DescribeImageTagsCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeImageTagsCommandOutput} for command's `response` shape.
30
37
  * @see {@link ECRPUBLICClientResolvedConfig | config} for ECRPUBLICClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DescribeImageTagsCommandOutput extends DescribeImageTagsRespons
48
55
  export declare class DescribeImageTagsCommand extends $Command<DescribeImageTagsCommandInput, DescribeImageTagsCommandOutput, ECRPUBLICClientResolvedConfig> {
49
56
  readonly input: DescribeImageTagsCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DescribeImageTagsCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRPUBLICClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeImageTagsCommandInput, DescribeImageTagsCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }