@aws-sdk/client-ecr 3.451.0 → 3.454.0

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

@@ -24,7 +24,9 @@ export interface CreatePullThroughCacheRuleCommandOutput extends CreatePullThrou
 /**
  * @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>
+ *             images from an upstream registry source in your Amazon ECR private registry. For more
+ *             information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache.html">Using pull through cache
+ *                 rules</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
@@ -35,6 +37,8 @@ export interface CreatePullThroughCacheRuleCommandOutput extends CreatePullThrou
  *   ecrRepositoryPrefix: "STRING_VALUE", // required
  *   upstreamRegistryUrl: "STRING_VALUE", // required
  *   registryId: "STRING_VALUE",
+ *   upstreamRegistry: "ecr-public" || "quay" || "k8s" || "docker-hub" || "github-container-registry" || "azure-container-registry",
+ *   credentialArn: "STRING_VALUE",
  * };
  * const command = new CreatePullThroughCacheRuleCommand(input);
  * const response = await client.send(command);
@@ -43,6 +47,8 @@ export interface CreatePullThroughCacheRuleCommandOutput extends CreatePullThrou
  * //   upstreamRegistryUrl: "STRING_VALUE",
  * //   createdAt: new Date("TIMESTAMP"),
  * //   registryId: "STRING_VALUE",
+ * //   upstreamRegistry: "ecr-public" || "quay" || "k8s" || "docker-hub" || "github-container-registry" || "azure-container-registry",
+ * //   credentialArn: "STRING_VALUE",
  * // };
  *
  * ```
@@ -66,9 +72,21 @@ export interface CreatePullThroughCacheRuleCommandOutput extends CreatePullThrou
  *  <p>A pull through cache rule with these settings already exists for the private
  *             registry.</p>
  *
+ * @throws {@link SecretNotFoundException} (client fault)
+ *  <p>The ARN of the secret specified in the pull through cache rule was not found. Update
+ *             the pull through cache rule with a valid secret ARN and try again.</p>
+ *
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server-side issue.</p>
  *
+ * @throws {@link UnableToAccessSecretException} (client fault)
+ *  <p>The secret is unable to be accessed. Verify the resource permissions for the secret
+ *             and try again.</p>
+ *
+ * @throws {@link UnableToDecryptSecretValueException} (client fault)
+ *  <p>The secret is accessible but is unable to be decrypted. Verify the resource
+ *             permisisons and try again.</p>
+ *
  * @throws {@link UnsupportedUpstreamRegistryException} (client fault)
  *  <p>The specified upstream registry isn't supported.</p>
  *

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

@@ -41,6 +41,7 @@ export interface DeletePullThroughCacheRuleCommandOutput extends DeletePullThrou
  * //   upstreamRegistryUrl: "STRING_VALUE",
  * //   createdAt: new Date("TIMESTAMP"),
  * //   registryId: "STRING_VALUE",
+ * //   credentialArn: "STRING_VALUE",
  * // };
  *
  * ```

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

@@ -23,9 +23,9 @@ export interface DeleteRepositoryCommandOutput extends DeleteRepositoryResponse,
 }
 /**
  * @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>
+ * <p>Deletes a repository. If the repository isn't empty, you must either delete the
+ *             contents of the repository or use the <code>force</code> option to delete the repository
+ *             and have Amazon ECR delete all of its contents on your behalf.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -47,6 +47,9 @@ export interface DescribePullThroughCacheRulesCommandOutput extends DescribePull
  * //       upstreamRegistryUrl: "STRING_VALUE",
  * //       createdAt: new Date("TIMESTAMP"),
  * //       registryId: "STRING_VALUE",
+ * //       credentialArn: "STRING_VALUE",
+ * //       upstreamRegistry: "ecr-public" || "quay" || "k8s" || "docker-hub" || "github-container-registry" || "azure-container-registry",
+ * //       updatedAt: new Date("TIMESTAMP"),
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

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

@@ -76,6 +76,10 @@ export interface GetDownloadUrlForLayerCommandOutput extends GetDownloadUrlForLa
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server-side issue.</p>
  *
+ * @throws {@link UnableToGetUpstreamLayerException} (client fault)
+ *  <p>There was an issue getting the upstream layer matching the pull through cache
+ *             rule.</p>
+ *
  * @throws {@link ECRServiceException}
  * <p>Base exception class for all service exceptions from ECR service.</p>
  *

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

@@ -0,0 +1,104 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
+import { UpdatePullThroughCacheRuleRequest, UpdatePullThroughCacheRuleResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdatePullThroughCacheRuleCommand}.
+ */
+export interface UpdatePullThroughCacheRuleCommandInput extends UpdatePullThroughCacheRuleRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdatePullThroughCacheRuleCommand}.
+ */
+export interface UpdatePullThroughCacheRuleCommandOutput extends UpdatePullThroughCacheRuleResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates an existing pull through cache rule.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ECRClient, UpdatePullThroughCacheRuleCommand } from "@aws-sdk/client-ecr"; // ES Modules import
+ * // const { ECRClient, UpdatePullThroughCacheRuleCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
+ * const client = new ECRClient(config);
+ * const input = { // UpdatePullThroughCacheRuleRequest
+ *   registryId: "STRING_VALUE",
+ *   ecrRepositoryPrefix: "STRING_VALUE", // required
+ *   credentialArn: "STRING_VALUE", // required
+ * };
+ * const command = new UpdatePullThroughCacheRuleCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdatePullThroughCacheRuleResponse
+ * //   ecrRepositoryPrefix: "STRING_VALUE",
+ * //   registryId: "STRING_VALUE",
+ * //   updatedAt: new Date("TIMESTAMP"),
+ * //   credentialArn: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param UpdatePullThroughCacheRuleCommandInput - {@link UpdatePullThroughCacheRuleCommandInput}
+ * @returns {@link UpdatePullThroughCacheRuleCommandOutput}
+ * @see {@link UpdatePullThroughCacheRuleCommandInput} for command's `input` shape.
+ * @see {@link UpdatePullThroughCacheRuleCommandOutput} 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 PullThroughCacheRuleNotFoundException} (client fault)
+ *  <p>The pull through cache rule was not found. Specify a valid pull through cache rule and
+ *             try again.</p>
+ *
+ * @throws {@link SecretNotFoundException} (client fault)
+ *  <p>The ARN of the secret specified in the pull through cache rule was not found. Update
+ *             the pull through cache rule with a valid secret ARN and try again.</p>
+ *
+ * @throws {@link ServerException} (server fault)
+ *  <p>These errors are usually caused by a server-side issue.</p>
+ *
+ * @throws {@link UnableToAccessSecretException} (client fault)
+ *  <p>The secret is unable to be accessed. Verify the resource permissions for the secret
+ *             and try again.</p>
+ *
+ * @throws {@link UnableToDecryptSecretValueException} (client fault)
+ *  <p>The secret is accessible but is unable to be decrypted. Verify the resource
+ *             permisisons and try again.</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>
+ *
+ */
+export declare class UpdatePullThroughCacheRuleCommand extends $Command<UpdatePullThroughCacheRuleCommandInput, UpdatePullThroughCacheRuleCommandOutput, ECRClientResolvedConfig> {
+    readonly input: UpdatePullThroughCacheRuleCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdatePullThroughCacheRuleCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePullThroughCacheRuleCommandInput, UpdatePullThroughCacheRuleCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -0,0 +1,96 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ECRClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECRClient";
+import { ValidatePullThroughCacheRuleRequest, ValidatePullThroughCacheRuleResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ValidatePullThroughCacheRuleCommand}.
+ */
+export interface ValidatePullThroughCacheRuleCommandInput extends ValidatePullThroughCacheRuleRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ValidatePullThroughCacheRuleCommand}.
+ */
+export interface ValidatePullThroughCacheRuleCommandOutput extends ValidatePullThroughCacheRuleResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Validates an existing pull through cache rule for an upstream registry that requires
+ *             authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the
+ *             syntax, and then validate that authentication to the upstream registry is
+ *             successful.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ECRClient, ValidatePullThroughCacheRuleCommand } from "@aws-sdk/client-ecr"; // ES Modules import
+ * // const { ECRClient, ValidatePullThroughCacheRuleCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
+ * const client = new ECRClient(config);
+ * const input = { // ValidatePullThroughCacheRuleRequest
+ *   ecrRepositoryPrefix: "STRING_VALUE", // required
+ *   registryId: "STRING_VALUE",
+ * };
+ * const command = new ValidatePullThroughCacheRuleCommand(input);
+ * const response = await client.send(command);
+ * // { // ValidatePullThroughCacheRuleResponse
+ * //   ecrRepositoryPrefix: "STRING_VALUE",
+ * //   registryId: "STRING_VALUE",
+ * //   upstreamRegistryUrl: "STRING_VALUE",
+ * //   credentialArn: "STRING_VALUE",
+ * //   isValid: true || false,
+ * //   failure: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ValidatePullThroughCacheRuleCommandInput - {@link ValidatePullThroughCacheRuleCommandInput}
+ * @returns {@link ValidatePullThroughCacheRuleCommandOutput}
+ * @see {@link ValidatePullThroughCacheRuleCommandInput} for command's `input` shape.
+ * @see {@link ValidatePullThroughCacheRuleCommandOutput} 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 PullThroughCacheRuleNotFoundException} (client fault)
+ *  <p>The pull through cache rule was not found. Specify a valid pull through cache rule and
+ *             try again.</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>
+ *
+ */
+export declare class ValidatePullThroughCacheRuleCommand extends $Command<ValidatePullThroughCacheRuleCommandInput, ValidatePullThroughCacheRuleCommandOutput, ECRClientResolvedConfig> {
+    readonly input: ValidatePullThroughCacheRuleCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ValidatePullThroughCacheRuleCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ECRClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ValidatePullThroughCacheRuleCommandInput, ValidatePullThroughCacheRuleCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -38,4 +38,6 @@ export * from "./StartImageScanCommand";
 export * from "./StartLifecyclePolicyPreviewCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdatePullThroughCacheRuleCommand";
 export * from "./UploadLayerPartCommand";
+export * from "./ValidatePullThroughCacheRuleCommand";