@aws-sdk/client-ecr 3.934.0 → 3.936.0

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

@@ -0,0 +1,127 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
+import { ListPullTimeUpdateExclusionsRequest, ListPullTimeUpdateExclusionsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListPullTimeUpdateExclusionsCommand}.
+ */
+export interface ListPullTimeUpdateExclusionsCommandInput extends ListPullTimeUpdateExclusionsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListPullTimeUpdateExclusionsCommand}.
+ */
+export interface ListPullTimeUpdateExclusionsCommandOutput extends ListPullTimeUpdateExclusionsResponse, __MetadataBearer {
+}
+declare const ListPullTimeUpdateExclusionsCommand_base: {
+    new (input: ListPullTimeUpdateExclusionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListPullTimeUpdateExclusionsCommandInput, ListPullTimeUpdateExclusionsCommandOutput, ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListPullTimeUpdateExclusionsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListPullTimeUpdateExclusionsCommandInput, ListPullTimeUpdateExclusionsCommandOutput, ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists the IAM principals that are excluded from having their image pull times recorded.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ECRClient, ListPullTimeUpdateExclusionsCommand } from "@aws-sdk/client-ecr"; // ES Modules import
+ * // const { ECRClient, ListPullTimeUpdateExclusionsCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
+ * // import type { ECRClientConfig } from "@aws-sdk/client-ecr";
+ * const config = {}; // type is ECRClientConfig
+ * const client = new ECRClient(config);
+ * const input = { // ListPullTimeUpdateExclusionsRequest
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListPullTimeUpdateExclusionsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListPullTimeUpdateExclusionsResponse
+ * //   pullTimeUpdateExclusions: [ // PullTimeUpdateExclusionList
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListPullTimeUpdateExclusionsCommandInput - {@link ListPullTimeUpdateExclusionsCommandInput}
+ * @returns {@link ListPullTimeUpdateExclusionsCommandOutput}
+ * @see {@link ListPullTimeUpdateExclusionsCommandInput} for command's `input` shape.
+ * @see {@link ListPullTimeUpdateExclusionsCommandOutput} for command's `response` shape.
+ * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>The specified parameter is invalid. Review the available parameters for the API
+ *             request.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>The operation did not succeed because it would have exceeded a service limit for your
+ *             account. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html">Amazon ECR service quotas</a> in
+ *             the Amazon Elastic Container Registry User Guide.</p>
+ *
+ * @throws {@link ServerException} (server fault)
+ *  <p>These errors are usually caused by a server-side issue.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There was an exception validating this request.</p>
+ *
+ * @throws {@link ECRServiceException}
+ * <p>Base exception class for all service exceptions from ECR service.</p>
+ *
+ *
+ * @example To list all pull time update exclusions
+ * ```javascript
+ * // This example lists all IAM principals that are excluded from having their image pull timestamps recorded in the registry.
+ * const input = { /* empty *\/ };
+ * const command = new ListPullTimeUpdateExclusionsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   pullTimeUpdateExclusions: [
+ *     "arn:aws:iam::012345678910:role/ECRAccess"
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @example To list pull time update exclusions with pagination
+ * ```javascript
+ * // This example lists pull time update exclusions with pagination, requesting a maximum of 2 results per page.
+ * const input = {
+ *   maxResults: 2
+ * };
+ * const command = new ListPullTimeUpdateExclusionsCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   nextToken: "eyJlbmNyeXB0ZWREYXRhIjpbXX0=",
+ *   pullTimeUpdateExclusions: [
+ *     "arn:aws:iam::012345678910:role/ECRAccess",
+ *     "arn:aws:iam::012345678910:role/CICDPipeline"
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class ListPullTimeUpdateExclusionsCommand extends ListPullTimeUpdateExclusionsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListPullTimeUpdateExclusionsRequest;
+            output: ListPullTimeUpdateExclusionsResponse;
+        };
+        sdk: {
+            input: ListPullTimeUpdateExclusionsCommandInput;
+            output: ListPullTimeUpdateExclusionsCommandOutput;
+        };
+    };
+}

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

@@ -77,6 +77,9 @@ declare const PutRegistryScanningConfigurationCommand_base: {
  * @see {@link PutRegistryScanningConfigurationCommandOutput} for command's `response` shape.
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
  *
+ * @throws {@link BlockedByOrganizationPolicyException} (client fault)
+ *  <p>The operation did not succeed because the account is managed by a organization policy.</p>
+ *
  * @throws {@link InvalidParameterException} (client fault)
  *  <p>The specified parameter is invalid. Review the available parameters for the API
  *             request.</p>

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

@@ -0,0 +1,93 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
+import { RegisterPullTimeUpdateExclusionRequest, RegisterPullTimeUpdateExclusionResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link RegisterPullTimeUpdateExclusionCommand}.
+ */
+export interface RegisterPullTimeUpdateExclusionCommandInput extends RegisterPullTimeUpdateExclusionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link RegisterPullTimeUpdateExclusionCommand}.
+ */
+export interface RegisterPullTimeUpdateExclusionCommandOutput extends RegisterPullTimeUpdateExclusionResponse, __MetadataBearer {
+}
+declare const RegisterPullTimeUpdateExclusionCommand_base: {
+    new (input: RegisterPullTimeUpdateExclusionCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterPullTimeUpdateExclusionCommandInput, RegisterPullTimeUpdateExclusionCommandOutput, ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: RegisterPullTimeUpdateExclusionCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterPullTimeUpdateExclusionCommandInput, RegisterPullTimeUpdateExclusionCommandOutput, ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Adds an IAM principal to the pull time update exclusion list for a registry. Amazon ECR will not record the pull time if an excluded principal pulls an image.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ECRClient, RegisterPullTimeUpdateExclusionCommand } from "@aws-sdk/client-ecr"; // ES Modules import
+ * // const { ECRClient, RegisterPullTimeUpdateExclusionCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
+ * // import type { ECRClientConfig } from "@aws-sdk/client-ecr";
+ * const config = {}; // type is ECRClientConfig
+ * const client = new ECRClient(config);
+ * const input = { // RegisterPullTimeUpdateExclusionRequest
+ *   principalArn: "STRING_VALUE", // required
+ * };
+ * const command = new RegisterPullTimeUpdateExclusionCommand(input);
+ * const response = await client.send(command);
+ * // { // RegisterPullTimeUpdateExclusionResponse
+ * //   principalArn: "STRING_VALUE",
+ * //   createdAt: new Date("TIMESTAMP"),
+ * // };
+ *
+ * ```
+ *
+ * @param RegisterPullTimeUpdateExclusionCommandInput - {@link RegisterPullTimeUpdateExclusionCommandInput}
+ * @returns {@link RegisterPullTimeUpdateExclusionCommandOutput}
+ * @see {@link RegisterPullTimeUpdateExclusionCommandInput} for command's `input` shape.
+ * @see {@link RegisterPullTimeUpdateExclusionCommandOutput} for command's `response` shape.
+ * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
+ *
+ * @throws {@link ExclusionAlreadyExistsException} (client fault)
+ *  <p>The specified pull time update exclusion already exists for the registry.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>The specified parameter is invalid. Review the available parameters for the API
+ *             request.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>The operation did not succeed because it would have exceeded a service limit for your
+ *             account. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html">Amazon ECR service quotas</a> in
+ *             the Amazon Elastic Container Registry User Guide.</p>
+ *
+ * @throws {@link ServerException} (server fault)
+ *  <p>These errors are usually caused by a server-side issue.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There was an exception validating this request.</p>
+ *
+ * @throws {@link ECRServiceException}
+ * <p>Base exception class for all service exceptions from ECR service.</p>
+ *
+ *
+ * @public
+ */
+export declare class RegisterPullTimeUpdateExclusionCommand extends RegisterPullTimeUpdateExclusionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: RegisterPullTimeUpdateExclusionRequest;
+            output: RegisterPullTimeUpdateExclusionResponse;
+        };
+        sdk: {
+            input: RegisterPullTimeUpdateExclusionCommandInput;
+            output: RegisterPullTimeUpdateExclusionCommandOutput;
+        };
+    };
+}

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

@@ -28,11 +28,10 @@ declare const StartImageScanCommand_base: {
 };
 /**
  * <p>Starts a basic image vulnerability scan.</p>
- *          <p> A basic 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. You can start up to 100,000 basic scans per 24 hours. This limit includes both scans on initial push
- *             and scans initiated by the StartImageScan API. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning-basic.html">Basic scanning</a> in the
- *                 <i>Amazon Elastic Container Registry User Guide</i>.</p>
+ *          <p> A basic 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. You can start up to 100,000
+ *             basic scans per 24 hours. This limit includes both scans on initial push and scans
+ *             initiated by the StartImageScan API. For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning-basic.html">Basic scanning</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,7 +58,7 @@ declare const StartImageScanCommand_base: {
  * //     imageTag: "STRING_VALUE",
  * //   },
  * //   imageScanStatus: { // ImageScanStatus
- * //     status: "IN_PROGRESS" || "COMPLETE" || "FAILED" || "UNSUPPORTED_IMAGE" || "ACTIVE" || "PENDING" || "SCAN_ELIGIBILITY_EXPIRED" || "FINDINGS_UNAVAILABLE" || "LIMIT_EXCEEDED",
+ * //     status: "IN_PROGRESS" || "COMPLETE" || "FAILED" || "UNSUPPORTED_IMAGE" || "ACTIVE" || "PENDING" || "SCAN_ELIGIBILITY_EXPIRED" || "FINDINGS_UNAVAILABLE" || "LIMIT_EXCEEDED" || "IMAGE_ARCHIVED",
  * //     description: "STRING_VALUE",
  * //   },
  * // };
@@ -72,6 +71,9 @@ declare const StartImageScanCommand_base: {
  * @see {@link StartImageScanCommandOutput} for command's `response` shape.
  * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
  *
+ * @throws {@link ImageArchivedException} (client fault)
+ *  <p>The specified image is archived and cannot be scanned.</p>
+ *
  * @throws {@link ImageNotFoundException} (client fault)
  *  <p>The image requested does not exist in the specified repository.</p>
  *

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

@@ -0,0 +1,156 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
+import { UpdateImageStorageClassRequest, UpdateImageStorageClassResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateImageStorageClassCommand}.
+ */
+export interface UpdateImageStorageClassCommandInput extends UpdateImageStorageClassRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateImageStorageClassCommand}.
+ */
+export interface UpdateImageStorageClassCommandOutput extends UpdateImageStorageClassResponse, __MetadataBearer {
+}
+declare const UpdateImageStorageClassCommand_base: {
+    new (input: UpdateImageStorageClassCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateImageStorageClassCommandInput, UpdateImageStorageClassCommandOutput, ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateImageStorageClassCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateImageStorageClassCommandInput, UpdateImageStorageClassCommandOutput, ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Transitions an image between storage classes. You can transition images from Amazon ECR standard storage class to Amazon ECR archival storage class for long-term storage, or restore archived images back to Amazon ECR standard.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ECRClient, UpdateImageStorageClassCommand } from "@aws-sdk/client-ecr"; // ES Modules import
+ * // const { ECRClient, UpdateImageStorageClassCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
+ * // import type { ECRClientConfig } from "@aws-sdk/client-ecr";
+ * const config = {}; // type is ECRClientConfig
+ * const client = new ECRClient(config);
+ * const input = { // UpdateImageStorageClassRequest
+ *   registryId: "STRING_VALUE",
+ *   repositoryName: "STRING_VALUE", // required
+ *   imageId: { // ImageIdentifier
+ *     imageDigest: "STRING_VALUE",
+ *     imageTag: "STRING_VALUE",
+ *   },
+ *   targetStorageClass: "STANDARD" || "ARCHIVE", // required
+ * };
+ * const command = new UpdateImageStorageClassCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateImageStorageClassResponse
+ * //   registryId: "STRING_VALUE",
+ * //   repositoryName: "STRING_VALUE",
+ * //   imageId: { // ImageIdentifier
+ * //     imageDigest: "STRING_VALUE",
+ * //     imageTag: "STRING_VALUE",
+ * //   },
+ * //   imageStatus: "ACTIVE" || "ARCHIVED" || "ACTIVATING",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateImageStorageClassCommandInput - {@link UpdateImageStorageClassCommandInput}
+ * @returns {@link UpdateImageStorageClassCommandOutput}
+ * @see {@link UpdateImageStorageClassCommandInput} for command's `input` shape.
+ * @see {@link UpdateImageStorageClassCommandOutput} for command's `response` shape.
+ * @see {@link ECRClientResolvedConfig | config} for ECRClient's `config` shape.
+ *
+ * @throws {@link ImageNotFoundException} (client fault)
+ *  <p>The image requested does not exist in the specified repository.</p>
+ *
+ * @throws {@link ImageStorageClassUpdateNotSupportedException} (client fault)
+ *  <p>The requested image storage class update is not supported.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>The specified parameter is invalid. Review the available parameters for the API
+ *             request.</p>
+ *
+ * @throws {@link RepositoryNotFoundException} (client fault)
+ *  <p>The specified repository could not be found. Check the spelling of the specified
+ *             repository and ensure that you are performing operations on the correct registry.</p>
+ *
+ * @throws {@link ServerException} (server fault)
+ *  <p>These errors are usually caused by a server-side issue.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>There was an exception validating this request.</p>
+ *
+ * @throws {@link ECRServiceException}
+ * <p>Base exception class for all service exceptions from ECR service.</p>
+ *
+ *
+ * @example To transition an image to Amazon ECR Archive
+ * ```javascript
+ * // This example transitions an image with a specific digest in the hello-repository repository to Amazon ECR Archive storage for long-term archival.
+ * const input = {
+ *   imageId: {
+ *     imageDigest: "sha256:0b1a4e0c81c434fa7928e5c4a2651a521ebabc4ff200c65f7e25b99373efca3b"
+ *   },
+ *   registryId: "724772093679",
+ *   repositoryName: "hello-repository",
+ *   targetStorageClass: "ARCHIVE"
+ * };
+ * const command = new UpdateImageStorageClassCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   imageId: {
+ *     imageDigest: "sha256:0b1a4e0c81c434fa7928e5c4a2651a521ebabc4ff200c65f7e25b99373efca3b"
+ *   },
+ *   imageStatus: "ARCHIVED",
+ *   registryId: "724772093679",
+ *   repositoryName: "hello-repository"
+ * }
+ * *\/
+ * ```
+ *
+ * @example To restore an archived image to Amazon ECR Standard
+ * ```javascript
+ * // This example restores an archived image with a specific digest back to Amazon ECR Standard storage.
+ * const input = {
+ *   imageId: {
+ *     imageDigest: "sha256:0b1a4e0c81c434fa7928e5c4a2651a521ebabc4ff200c65f7e25b99373efca3b"
+ *   },
+ *   registryId: "724772093679",
+ *   repositoryName: "hello-repository",
+ *   targetStorageClass: "STANDARD"
+ * };
+ * const command = new UpdateImageStorageClassCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   imageId: {
+ *     imageDigest: "sha256:0b1a4e0c81c434fa7928e5c4a2651a521ebabc4ff200c65f7e25b99373efca3b"
+ *   },
+ *   imageStatus: "ACTIVATING",
+ *   registryId: "724772093679",
+ *   repositoryName: "hello-repository"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class UpdateImageStorageClassCommand extends UpdateImageStorageClassCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateImageStorageClassRequest;
+            output: UpdateImageStorageClassResponse;
+        };
+        sdk: {
+            input: UpdateImageStorageClassCommandInput;
+            output: UpdateImageStorageClassCommandOutput;
+        };
+    };
+}

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

@@ -12,6 +12,7 @@ export * from "./DeleteRegistryPolicyCommand";
 export * from "./DeleteRepositoryCommand";
 export * from "./DeleteRepositoryCreationTemplateCommand";
 export * from "./DeleteRepositoryPolicyCommand";
+export * from "./DeregisterPullTimeUpdateExclusionCommand";
 export * from "./DescribeImageReplicationStatusCommand";
 export * from "./DescribeImageScanFindingsCommand";
 export * from "./DescribeImagesCommand";
@@ -28,7 +29,9 @@ export * from "./GetRegistryPolicyCommand";
 export * from "./GetRegistryScanningConfigurationCommand";
 export * from "./GetRepositoryPolicyCommand";
 export * from "./InitiateLayerUploadCommand";
+export * from "./ListImageReferrersCommand";
 export * from "./ListImagesCommand";
+export * from "./ListPullTimeUpdateExclusionsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./PutAccountSettingCommand";
 export * from "./PutImageCommand";
@@ -38,11 +41,13 @@ export * from "./PutLifecyclePolicyCommand";
 export * from "./PutRegistryPolicyCommand";
 export * from "./PutRegistryScanningConfigurationCommand";
 export * from "./PutReplicationConfigurationCommand";
+export * from "./RegisterPullTimeUpdateExclusionCommand";
 export * from "./SetRepositoryPolicyCommand";
 export * from "./StartImageScanCommand";
 export * from "./StartLifecyclePolicyPreviewCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateImageStorageClassCommand";
 export * from "./UpdatePullThroughCacheRuleCommand";
 export * from "./UpdateRepositoryCreationTemplateCommand";
 export * from "./UploadLayerPartCommand";

package/dist-types/index.d.ts

@@ -19,5 +19,7 @@ export type { ECRExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
 export * from "./pagination";
 export * from "./waiters";
-export * from "./models";
+export * from "./models/enums";
+export * from "./models/errors";
+export type * from "./models/models_0";
 export { ECRServiceException } from "./models/ECRServiceException";