DeletePullThroughCacheRuleCommand

Deletes a pull through cache rule.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ECRClient, DeletePullThroughCacheRuleCommand } from "@aws-sdk/client-ecr"; // ES Modules import
// const { ECRClient, DeletePullThroughCacheRuleCommand } = require("@aws-sdk/client-ecr"); // CommonJS import
const client = new ECRClient(config);
const input = { // DeletePullThroughCacheRuleRequest
  ecrRepositoryPrefix: "STRING_VALUE", // required
  registryId: "STRING_VALUE",
};
const command = new DeletePullThroughCacheRuleCommand(input);
const response = await client.send(command);
// { // DeletePullThroughCacheRuleResponse
//   ecrRepositoryPrefix: "STRING_VALUE",
//   upstreamRegistryUrl: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   registryId: "STRING_VALUE",
//   credentialArn: "STRING_VALUE",
//   customRoleArn: "STRING_VALUE",
//   upstreamRepositoryPrefix: "STRING_VALUE",
// };

DeletePullThroughCacheRuleCommand Input

Parameter
Type
Description
ecrRepositoryPrefix
Required
string | undefined

The Amazon ECR repository prefix associated with the pull through cache rule to delete.

registryId
string | undefined

The Amazon Web Services account ID associated with the registry that contains the pull through cache rule. If you do not specify a registry, the default registry is assumed.

DeletePullThroughCacheRuleCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
createdAt
Date | undefined

The timestamp associated with the pull through cache rule.

credentialArn
string | undefined

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache rule.

customRoleArn
string | undefined

The ARN of the IAM role associated with the pull through cache rule.

ecrRepositoryPrefix
string | undefined

The Amazon ECR repository prefix associated with the request.

registryId
string | undefined

The registry ID associated with the request.

upstreamRegistryUrl
string | undefined

The upstream registry URL associated with the pull through cache rule.

upstreamRepositoryPrefix
string | undefined

The upstream repository prefix associated with the pull through cache rule.

Throws

Name
Fault
Details
InvalidParameterException
client

The specified parameter is invalid. Review the available parameters for the API request.

PullThroughCacheRuleNotFoundException
client

The pull through cache rule was not found. Specify a valid pull through cache rule and try again.

ServerException
server

These errors are usually caused by a server-side issue.

ValidationException
client

There was an exception validating this request.

ECRServiceException
Base exception class for all service exceptions from ECR service.