@aws-sdk/client-ecr 3.296.0 → 3.298.0

package/dist-types/ECR.d.ts

@@ -42,6 +42,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
 import { UploadLayerPartCommandInput, UploadLayerPartCommandOutput } from "./commands/UploadLayerPartCommand";
 import { ECRClient } from "./ECRClient";
 /**
+ * @public
  * <fullname>Amazon Elastic Container Registry</fullname>
  *         <p>Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the
  *             familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR
@@ -54,6 +55,7 @@ import { ECRClient } from "./ECRClient";
  */
 export declare class ECR extends ECRClient {
     /**
+     * @public
      * <p>Checks the availability of one or more image layers in a repository.</p>
      *         <p>When an image is pushed to a repository, each image layer is checked to verify if it
      *             has been uploaded before. If it has been uploaded, then the image layer is
@@ -67,6 +69,7 @@ export declare class ECR extends ECRClient {
     batchCheckLayerAvailability(args: BatchCheckLayerAvailabilityCommandInput, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void): void;
     batchCheckLayerAvailability(args: BatchCheckLayerAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCheckLayerAvailabilityCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a list of specified images within a repository. Images are specified with
      *             either an <code>imageTag</code> or <code>imageDigest</code>.</p>
      *         <p>You can remove a tag from an image by specifying the image's tag in your request. When
@@ -78,6 +81,7 @@ export declare class ECR extends ECRClient {
     batchDeleteImage(args: BatchDeleteImageCommandInput, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void): void;
     batchDeleteImage(args: BatchDeleteImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteImageCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets detailed information for an image. Images are specified with either an
      *                 <code>imageTag</code> or <code>imageDigest</code>.</p>
      *         <p>When an image is pulled, the BatchGetImage API is called once to retrieve the image
@@ -87,12 +91,14 @@ export declare class ECR extends ECRClient {
     batchGetImage(args: BatchGetImageCommandInput, cb: (err: any, data?: BatchGetImageCommandOutput) => void): void;
     batchGetImage(args: BatchGetImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetImageCommandOutput) => void): void;
     /**
+     * @public
      * <p>Gets the scanning configuration for one or more repositories.</p>
      */
     batchGetRepositoryScanningConfiguration(args: BatchGetRepositoryScanningConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetRepositoryScanningConfigurationCommandOutput>;
     batchGetRepositoryScanningConfiguration(args: BatchGetRepositoryScanningConfigurationCommandInput, cb: (err: any, data?: BatchGetRepositoryScanningConfigurationCommandOutput) => void): void;
     batchGetRepositoryScanningConfiguration(args: BatchGetRepositoryScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetRepositoryScanningConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Informs Amazon ECR that the image layer upload has completed for a specified registry,
      *             repository name, and upload ID. You can optionally provide a <code>sha256</code> digest
      *             of the image layer for data validation purposes.</p>
@@ -107,6 +113,7 @@ export declare class ECR extends ECRClient {
     completeLayerUpload(args: CompleteLayerUploadCommandInput, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void): void;
     completeLayerUpload(args: CompleteLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteLayerUploadCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a pull through cache rule. A pull through cache rule provides a way to cache
      *             images from an external public registry in your Amazon ECR private registry.</p>
      */
@@ -114,6 +121,7 @@ export declare class ECR extends ECRClient {
     createPullThroughCacheRule(args: CreatePullThroughCacheRuleCommandInput, cb: (err: any, data?: CreatePullThroughCacheRuleCommandOutput) => void): void;
     createPullThroughCacheRule(args: CreatePullThroughCacheRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePullThroughCacheRuleCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a repository. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html">Amazon ECR repositories</a> in the
      *                 <i>Amazon Elastic Container Registry User Guide</i>.</p>
      */
@@ -121,24 +129,28 @@ export declare class ECR extends ECRClient {
     createRepository(args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
     createRepository(args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the lifecycle policy associated with the specified repository.</p>
      */
     deleteLifecyclePolicy(args: DeleteLifecyclePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLifecyclePolicyCommandOutput>;
     deleteLifecyclePolicy(args: DeleteLifecyclePolicyCommandInput, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void): void;
     deleteLifecyclePolicy(args: DeleteLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLifecyclePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a pull through cache rule.</p>
      */
     deletePullThroughCacheRule(args: DeletePullThroughCacheRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeletePullThroughCacheRuleCommandOutput>;
     deletePullThroughCacheRule(args: DeletePullThroughCacheRuleCommandInput, cb: (err: any, data?: DeletePullThroughCacheRuleCommandOutput) => void): void;
     deletePullThroughCacheRule(args: DeletePullThroughCacheRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePullThroughCacheRuleCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the registry permissions policy.</p>
      */
     deleteRegistryPolicy(args: DeleteRegistryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRegistryPolicyCommandOutput>;
     deleteRegistryPolicy(args: DeleteRegistryPolicyCommandInput, cb: (err: any, data?: DeleteRegistryPolicyCommandOutput) => void): void;
     deleteRegistryPolicy(args: DeleteRegistryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegistryPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a repository. If the repository contains images, you must either delete all
      *             images in the repository or use the <code>force</code> option to delete the
      *             repository.</p>
@@ -147,18 +159,21 @@ export declare class ECR extends ECRClient {
     deleteRepository(args: DeleteRepositoryCommandInput, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void): void;
     deleteRepository(args: DeleteRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the repository policy associated with the specified repository.</p>
      */
     deleteRepositoryPolicy(args: DeleteRepositoryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRepositoryPolicyCommandOutput>;
     deleteRepositoryPolicy(args: DeleteRepositoryPolicyCommandInput, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void): void;
     deleteRepositoryPolicy(args: DeleteRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the replication status for a specified image.</p>
      */
     describeImageReplicationStatus(args: DescribeImageReplicationStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeImageReplicationStatusCommandOutput>;
     describeImageReplicationStatus(args: DescribeImageReplicationStatusCommandInput, cb: (err: any, data?: DescribeImageReplicationStatusCommandOutput) => void): void;
     describeImageReplicationStatus(args: DescribeImageReplicationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageReplicationStatusCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns metadata about the images in a repository.</p>
      *         <note>
      *             <p>Beginning with Docker version 1.9, the Docker client compresses image layers
@@ -171,18 +186,21 @@ export declare class ECR extends ECRClient {
     describeImages(args: DescribeImagesCommandInput, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void;
     describeImages(args: DescribeImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImagesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the scan findings for the specified image.</p>
      */
     describeImageScanFindings(args: DescribeImageScanFindingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeImageScanFindingsCommandOutput>;
     describeImageScanFindings(args: DescribeImageScanFindingsCommandInput, cb: (err: any, data?: DescribeImageScanFindingsCommandOutput) => void): void;
     describeImageScanFindings(args: DescribeImageScanFindingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeImageScanFindingsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the pull through cache rules for a registry.</p>
      */
     describePullThroughCacheRules(args: DescribePullThroughCacheRulesCommandInput, options?: __HttpHandlerOptions): Promise<DescribePullThroughCacheRulesCommandOutput>;
     describePullThroughCacheRules(args: DescribePullThroughCacheRulesCommandInput, cb: (err: any, data?: DescribePullThroughCacheRulesCommandOutput) => void): void;
     describePullThroughCacheRules(args: DescribePullThroughCacheRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePullThroughCacheRulesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes the settings for a registry. The replication configuration for a repository
      *             can be created or updated with the <a>PutReplicationConfiguration</a> API
      *             action.</p>
@@ -191,12 +209,14 @@ export declare class ECR extends ECRClient {
     describeRegistry(args: DescribeRegistryCommandInput, cb: (err: any, data?: DescribeRegistryCommandOutput) => void): void;
     describeRegistry(args: DescribeRegistryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRegistryCommandOutput) => void): void;
     /**
+     * @public
      * <p>Describes image repositories in a registry.</p>
      */
     describeRepositories(args: DescribeRepositoriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRepositoriesCommandOutput>;
     describeRepositories(args: DescribeRepositoriesCommandInput, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void): void;
     describeRepositories(args: DescribeRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRepositoriesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves an authorization token. An authorization token represents your IAM
      *             authentication credentials and can be used to access any Amazon ECR registry that your IAM
      *             principal has access to. The authorization token is valid for 12 hours.</p>
@@ -210,6 +230,7 @@ export declare class ECR extends ECRClient {
     getAuthorizationToken(args: GetAuthorizationTokenCommandInput, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void): void;
     getAuthorizationToken(args: GetAuthorizationTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAuthorizationTokenCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can
      *             only get URLs for image layers that are referenced in an image.</p>
      *         <p>When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer
@@ -223,12 +244,14 @@ export declare class ECR extends ECRClient {
     getDownloadUrlForLayer(args: GetDownloadUrlForLayerCommandInput, cb: (err: any, data?: GetDownloadUrlForLayerCommandOutput) => void): void;
     getDownloadUrlForLayer(args: GetDownloadUrlForLayerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDownloadUrlForLayerCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the lifecycle policy for the specified repository.</p>
      */
     getLifecyclePolicy(args: GetLifecyclePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetLifecyclePolicyCommandOutput>;
     getLifecyclePolicy(args: GetLifecyclePolicyCommandInput, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void): void;
     getLifecyclePolicy(args: GetLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLifecyclePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the results of the lifecycle policy preview request for the specified
      *             repository.</p>
      */
@@ -236,24 +259,28 @@ export declare class ECR extends ECRClient {
     getLifecyclePolicyPreview(args: GetLifecyclePolicyPreviewCommandInput, cb: (err: any, data?: GetLifecyclePolicyPreviewCommandOutput) => void): void;
     getLifecyclePolicyPreview(args: GetLifecyclePolicyPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLifecyclePolicyPreviewCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the permissions policy for a registry.</p>
      */
     getRegistryPolicy(args: GetRegistryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetRegistryPolicyCommandOutput>;
     getRegistryPolicy(args: GetRegistryPolicyCommandInput, cb: (err: any, data?: GetRegistryPolicyCommandOutput) => void): void;
     getRegistryPolicy(args: GetRegistryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegistryPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the scanning configuration for a registry.</p>
      */
     getRegistryScanningConfiguration(args: GetRegistryScanningConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetRegistryScanningConfigurationCommandOutput>;
     getRegistryScanningConfiguration(args: GetRegistryScanningConfigurationCommandInput, cb: (err: any, data?: GetRegistryScanningConfigurationCommandOutput) => void): void;
     getRegistryScanningConfiguration(args: GetRegistryScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegistryScanningConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves the repository policy for the specified repository.</p>
      */
     getRepositoryPolicy(args: GetRepositoryPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetRepositoryPolicyCommandOutput>;
     getRepositoryPolicy(args: GetRepositoryPolicyCommandInput, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void): void;
     getRepositoryPolicy(args: GetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Notifies Amazon ECR that you intend to upload an image layer.</p>
      *         <p>When an image is pushed, the InitiateLayerUpload API is called once per image layer
      *             that has not already been uploaded. Whether or not an image layer has been uploaded is
@@ -267,6 +294,7 @@ export declare class ECR extends ECRClient {
     initiateLayerUpload(args: InitiateLayerUploadCommandInput, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void): void;
     initiateLayerUpload(args: InitiateLayerUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitiateLayerUploadCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all the image IDs for the specified repository.</p>
      *         <p>You can filter images based on whether or not they are tagged by using the
      *                 <code>tagStatus</code> filter and specifying either <code>TAGGED</code>,
@@ -279,12 +307,14 @@ export declare class ECR extends ECRClient {
     listImages(args: ListImagesCommandInput, cb: (err: any, data?: ListImagesCommandOutput) => void): void;
     listImages(args: ListImagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImagesCommandOutput) => void): void;
     /**
+     * @public
      * <p>List the tags for an Amazon ECR resource.</p>
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates the image manifest and tags associated with an image.</p>
      *         <p>When an image is pushed and all new image layers have been uploaded, the PutImage API
      *             is called once to create or update the image manifest and the tags associated with the
@@ -299,6 +329,7 @@ export declare class ECR extends ECRClient {
     putImage(args: PutImageCommandInput, cb: (err: any, data?: PutImageCommandOutput) => void): void;
     putImage(args: PutImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageCommandOutput) => void): void;
     /**
+     * @public
      * <important>
      *             <p>The <code>PutImageScanningConfiguration</code> API is being deprecated, in favor
      *                 of specifying the image scanning configuration at the registry level. For more
@@ -310,6 +341,7 @@ export declare class ECR extends ECRClient {
     putImageScanningConfiguration(args: PutImageScanningConfigurationCommandInput, cb: (err: any, data?: PutImageScanningConfigurationCommandOutput) => void): void;
     putImageScanningConfiguration(args: PutImageScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageScanningConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the image tag mutability settings for the specified repository. For more
      *             information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html">Image tag
      *                 mutability</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
@@ -318,6 +350,7 @@ export declare class ECR extends ECRClient {
     putImageTagMutability(args: PutImageTagMutabilityCommandInput, cb: (err: any, data?: PutImageTagMutabilityCommandOutput) => void): void;
     putImageTagMutability(args: PutImageTagMutabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutImageTagMutabilityCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates the lifecycle policy for the specified repository. For more
      *             information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html">Lifecycle policy
      *                 template</a>.</p>
@@ -326,6 +359,7 @@ export declare class ECR extends ECRClient {
     putLifecyclePolicy(args: PutLifecyclePolicyCommandInput, cb: (err: any, data?: PutLifecyclePolicyCommandOutput) => void): void;
     putLifecyclePolicy(args: PutLifecyclePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLifecyclePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates the permissions policy for your registry.</p>
      *         <p>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 <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html">Registry permissions</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
@@ -334,12 +368,14 @@ export declare class ECR extends ECRClient {
     putRegistryPolicy(args: PutRegistryPolicyCommandInput, cb: (err: any, data?: PutRegistryPolicyCommandOutput) => void): void;
     putRegistryPolicy(args: PutRegistryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRegistryPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates the scanning configuration for your private registry.</p>
      */
     putRegistryScanningConfiguration(args: PutRegistryScanningConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutRegistryScanningConfigurationCommandOutput>;
     putRegistryScanningConfiguration(args: PutRegistryScanningConfigurationCommandInput, cb: (err: any, data?: PutRegistryScanningConfigurationCommandOutput) => void): void;
     putRegistryScanningConfiguration(args: PutRegistryScanningConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRegistryScanningConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates the replication configuration for a registry. The existing
      *             replication configuration for a repository can be retrieved with the <a>DescribeRegistry</a> API action. The first time the
      *             PutReplicationConfiguration API is called, a service-linked IAM role is created in
@@ -356,6 +392,7 @@ export declare class ECR extends ECRClient {
     putReplicationConfiguration(args: PutReplicationConfigurationCommandInput, cb: (err: any, data?: PutReplicationConfigurationCommandOutput) => void): void;
     putReplicationConfiguration(args: PutReplicationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutReplicationConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Applies a repository policy to the specified repository to control access permissions.
      *             For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html">Amazon ECR Repository
      *                 policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
@@ -364,6 +401,7 @@ export declare class ECR extends ECRClient {
     setRepositoryPolicy(args: SetRepositoryPolicyCommandInput, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void): void;
     setRepositoryPolicy(args: SetRepositoryPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetRepositoryPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Starts an image vulnerability scan. An image scan can only be started once per 24
      *             hours on an individual image. This limit includes if an image was scanned on initial
      *             push. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html">Image scanning</a> in the
@@ -373,6 +411,7 @@ export declare class ECR extends ECRClient {
     startImageScan(args: StartImageScanCommandInput, cb: (err: any, data?: StartImageScanCommandOutput) => void): void;
     startImageScan(args: StartImageScanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartImageScanCommandOutput) => void): void;
     /**
+     * @public
      * <p>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.</p>
      */
@@ -380,6 +419,7 @@ export declare class ECR extends ECRClient {
     startLifecyclePolicyPreview(args: StartLifecyclePolicyPreviewCommandInput, cb: (err: any, data?: StartLifecyclePolicyPreviewCommandOutput) => void): void;
     startLifecyclePolicyPreview(args: StartLifecyclePolicyPreviewCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLifecyclePolicyPreviewCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds specified tags to a resource with the specified ARN. Existing tags on a resource
      *             are not changed if they are not specified in the request parameters.</p>
      */
@@ -387,12 +427,14 @@ export declare class ECR extends ECRClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes specified tags from a resource.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Uploads an image layer part to Amazon ECR.</p>
      *         <p>When an image is pushed, each new image layer is uploaded in parts. The maximum size
      *             of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API

package/dist-types/ECRClient.d.ts

@@ -49,15 +49,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import { UploadLayerPartCommandInput, UploadLayerPartCommandOutput } from "./commands/UploadLayerPartCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BatchCheckLayerAvailabilityCommandInput | BatchDeleteImageCommandInput | BatchGetImageCommandInput | BatchGetRepositoryScanningConfigurationCommandInput | CompleteLayerUploadCommandInput | CreatePullThroughCacheRuleCommandInput | CreateRepositoryCommandInput | DeleteLifecyclePolicyCommandInput | DeletePullThroughCacheRuleCommandInput | DeleteRegistryPolicyCommandInput | DeleteRepositoryCommandInput | DeleteRepositoryPolicyCommandInput | DescribeImageReplicationStatusCommandInput | DescribeImageScanFindingsCommandInput | DescribeImagesCommandInput | DescribePullThroughCacheRulesCommandInput | DescribeRegistryCommandInput | DescribeRepositoriesCommandInput | GetAuthorizationTokenCommandInput | GetDownloadUrlForLayerCommandInput | GetLifecyclePolicyCommandInput | GetLifecyclePolicyPreviewCommandInput | GetRegistryPolicyCommandInput | GetRegistryScanningConfigurationCommandInput | GetRepositoryPolicyCommandInput | InitiateLayerUploadCommandInput | ListImagesCommandInput | ListTagsForResourceCommandInput | PutImageCommandInput | PutImageScanningConfigurationCommandInput | PutImageTagMutabilityCommandInput | PutLifecyclePolicyCommandInput | PutRegistryPolicyCommandInput | PutRegistryScanningConfigurationCommandInput | PutReplicationConfigurationCommandInput | SetRepositoryPolicyCommandInput | StartImageScanCommandInput | StartLifecyclePolicyPreviewCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UploadLayerPartCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BatchCheckLayerAvailabilityCommandOutput | BatchDeleteImageCommandOutput | BatchGetImageCommandOutput | BatchGetRepositoryScanningConfigurationCommandOutput | CompleteLayerUploadCommandOutput | CreatePullThroughCacheRuleCommandOutput | CreateRepositoryCommandOutput | DeleteLifecyclePolicyCommandOutput | DeletePullThroughCacheRuleCommandOutput | DeleteRegistryPolicyCommandOutput | DeleteRepositoryCommandOutput | DeleteRepositoryPolicyCommandOutput | DescribeImageReplicationStatusCommandOutput | DescribeImageScanFindingsCommandOutput | DescribeImagesCommandOutput | DescribePullThroughCacheRulesCommandOutput | DescribeRegistryCommandOutput | DescribeRepositoriesCommandOutput | GetAuthorizationTokenCommandOutput | GetDownloadUrlForLayerCommandOutput | GetLifecyclePolicyCommandOutput | GetLifecyclePolicyPreviewCommandOutput | GetRegistryPolicyCommandOutput | GetRegistryScanningConfigurationCommandOutput | GetRepositoryPolicyCommandOutput | InitiateLayerUploadCommandOutput | ListImagesCommandOutput | ListTagsForResourceCommandOutput | PutImageCommandOutput | PutImageScanningConfigurationCommandOutput | PutImageTagMutabilityCommandOutput | PutLifecyclePolicyCommandOutput | PutRegistryPolicyCommandOutput | PutRegistryScanningConfigurationCommandOutput | PutReplicationConfigurationCommandOutput | SetRepositoryPolicyCommandOutput | StartImageScanCommandOutput | StartLifecyclePolicyPreviewCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UploadLayerPartCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -147,23 +156,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type ECRClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of ECRClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of ECRClient class constructor that set the region, credentials and other options.
  */
 export interface ECRClientConfig extends ECRClientConfigType {
 }
+/**
+ * @public
+ */
 type ECRClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of ECRClient class. This is resolved and normalized from the {@link ECRClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of ECRClient class. This is resolved and normalized from the {@link ECRClientConfig | constructor configuration interface}.
  */
 export interface ECRClientResolvedConfig extends ECRClientResolvedConfigType {
 }
 /**
+ * @public
  * <fullname>Amazon Elastic Container Registry</fullname>
  *         <p>Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the
  *             familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR

package/dist-types/commands/BatchCheckLayerAvailabilityCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
 import { BatchCheckLayerAvailabilityRequest, BatchCheckLayerAvailabilityResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchCheckLayerAvailabilityCommand}.
  */
 export interface BatchCheckLayerAvailabilityCommandInput extends BatchCheckLayerAvailabilityRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchCheckLayerAvailabilityCommand}.
  */
 export interface BatchCheckLayerAvailabilityCommandOutput extends BatchCheckLayerAvailabilityResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Checks the availability of one or more image layers in a repository.</p>
  *         <p>When an image is pushed to a repository, each image layer is checked to verify if it
  *             has been uploaded before. If it has been uploaded, then the image layer is
@@ -32,6 +37,8 @@ export interface BatchCheckLayerAvailabilityCommandOutput extends BatchCheckLaye
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchCheckLayerAvailabilityCommandInput - {@link BatchCheckLayerAvailabilityCommandInput}
+ * @returns {@link BatchCheckLayerAvailabilityCommandOutput}
  * @see {@link BatchCheckLayerAvailabilityCommandInput} for command's `input` shape.
  * @see {@link BatchCheckLayerAvailabilityCommandOutput} for command's `response` shape.
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
@@ -52,11 +59,20 @@ export interface BatchCheckLayerAvailabilityCommandOutput extends BatchCheckLaye
 export declare class BatchCheckLayerAvailabilityCommand extends $Command<BatchCheckLayerAvailabilityCommandInput, BatchCheckLayerAvailabilityCommandOutput, ECRClientResolvedConfig> {
     readonly input: BatchCheckLayerAvailabilityCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchCheckLayerAvailabilityCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchCheckLayerAvailabilityCommandInput, BatchCheckLayerAvailabilityCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/BatchDeleteImageCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
 import { BatchDeleteImageRequest, BatchDeleteImageResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchDeleteImageCommand}.
  */
 export interface BatchDeleteImageCommandInput extends BatchDeleteImageRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchDeleteImageCommand}.
  */
 export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes a list of specified images within a repository. Images are specified with
  *             either an <code>imageTag</code> or <code>imageDigest</code>.</p>
  *         <p>You can remove a tag from an image by specifying the image's tag in your request. When
@@ -30,6 +35,8 @@ export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchDeleteImageCommandInput - {@link BatchDeleteImageCommandInput}
+ * @returns {@link BatchDeleteImageCommandOutput}
  * @see {@link BatchDeleteImageCommandInput} for command's `input` shape.
  * @see {@link BatchDeleteImageCommandOutput} for command's `response` shape.
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
@@ -77,11 +84,20 @@ export interface BatchDeleteImageCommandOutput extends BatchDeleteImageResponse,
 export declare class BatchDeleteImageCommand extends $Command<BatchDeleteImageCommandInput, BatchDeleteImageCommandOutput, ECRClientResolvedConfig> {
     readonly input: BatchDeleteImageCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchDeleteImageCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDeleteImageCommandInput, BatchDeleteImageCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/BatchGetImageCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
 import { BatchGetImageRequest, BatchGetImageResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchGetImageCommand}.
  */
 export interface BatchGetImageCommandInput extends BatchGetImageRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchGetImageCommand}.
  */
 export interface BatchGetImageCommandOutput extends BatchGetImageResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets detailed information for an image. Images are specified with either an
  *                 <code>imageTag</code> or <code>imageDigest</code>.</p>
  *         <p>When an image is pulled, the BatchGetImage API is called once to retrieve the image
@@ -28,6 +33,8 @@ export interface BatchGetImageCommandOutput extends BatchGetImageResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchGetImageCommandInput - {@link BatchGetImageCommandInput}
+ * @returns {@link BatchGetImageCommandOutput}
  * @see {@link BatchGetImageCommandInput} for command's `input` shape.
  * @see {@link BatchGetImageCommandOutput} for command's `response` shape.
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
@@ -80,11 +87,20 @@ export interface BatchGetImageCommandOutput extends BatchGetImageResponse, __Met
 export declare class BatchGetImageCommand extends $Command<BatchGetImageCommandInput, BatchGetImageCommandOutput, ECRClientResolvedConfig> {
     readonly input: BatchGetImageCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchGetImageCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetImageCommandInput, BatchGetImageCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/BatchGetRepositoryScanningConfigurationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
 import { BatchGetRepositoryScanningConfigurationRequest, BatchGetRepositoryScanningConfigurationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchGetRepositoryScanningConfigurationCommand}.
  */
 export interface BatchGetRepositoryScanningConfigurationCommandInput extends BatchGetRepositoryScanningConfigurationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchGetRepositoryScanningConfigurationCommand}.
  */
 export interface BatchGetRepositoryScanningConfigurationCommandOutput extends BatchGetRepositoryScanningConfigurationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Gets the scanning configuration for one or more repositories.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BatchGetRepositoryScanningConfigurationCommandOutput extends Ba
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchGetRepositoryScanningConfigurationCommandInput - {@link BatchGetRepositoryScanningConfigurationCommandInput}
+ * @returns {@link BatchGetRepositoryScanningConfigurationCommandOutput}
  * @see {@link BatchGetRepositoryScanningConfigurationCommandInput} for command's `input` shape.
  * @see {@link BatchGetRepositoryScanningConfigurationCommandOutput} for command's `response` shape.
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
@@ -48,11 +55,20 @@ export interface BatchGetRepositoryScanningConfigurationCommandOutput extends Ba
 export declare class BatchGetRepositoryScanningConfigurationCommand extends $Command<BatchGetRepositoryScanningConfigurationCommandInput, BatchGetRepositoryScanningConfigurationCommandOutput, ECRClientResolvedConfig> {
     readonly input: BatchGetRepositoryScanningConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchGetRepositoryScanningConfigurationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetRepositoryScanningConfigurationCommandInput, BatchGetRepositoryScanningConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CompleteLayerUploadCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
 import { CompleteLayerUploadRequest, CompleteLayerUploadResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CompleteLayerUploadCommand}.
  */
 export interface CompleteLayerUploadCommandInput extends CompleteLayerUploadRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CompleteLayerUploadCommand}.
  */
 export interface CompleteLayerUploadCommandOutput extends CompleteLayerUploadResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Informs Amazon ECR that the image layer upload has completed for a specified registry,
  *             repository name, and upload ID. You can optionally provide a <code>sha256</code> digest
  *             of the image layer for data validation purposes.</p>
@@ -33,6 +38,8 @@ export interface CompleteLayerUploadCommandOutput extends CompleteLayerUploadRes
  * const response = await client.send(command);
  * ```
  *
+ * @param CompleteLayerUploadCommandInput - {@link CompleteLayerUploadCommandInput}
+ * @returns {@link CompleteLayerUploadCommandOutput}
  * @see {@link CompleteLayerUploadCommandInput} for command's `input` shape.
  * @see {@link CompleteLayerUploadCommandOutput} for command's `response` shape.
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
@@ -73,11 +80,20 @@ export interface CompleteLayerUploadCommandOutput extends CompleteLayerUploadRes
 export declare class CompleteLayerUploadCommand extends $Command<CompleteLayerUploadCommandInput, CompleteLayerUploadCommandOutput, ECRClientResolvedConfig> {
     readonly input: CompleteLayerUploadCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CompleteLayerUploadCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CompleteLayerUploadCommandInput, CompleteLayerUploadCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }