ECR / Client / update_pull_through_cache_rule

update_pull_through_cache_rule#

ECR.Client.update_pull_through_cache_rule(**kwargs)#

Updates an existing pull through cache rule.

See also: AWS API Documentation

Request Syntax

response = client.update_pull_through_cache_rule(
    registryId='string',
    ecrRepositoryPrefix='string',
    credentialArn='string',
    customRoleArn='string'
)
Parameters:

  • registryId (string) – The Amazon Web Services account ID associated with the registry associated with the pull through cache rule. If you do not specify a registry, the default registry is assumed.

  • ecrRepositoryPrefix (string) –

    [REQUIRED]

    The repository name prefix to use when caching images from the source registry.

  • credentialArn (string) – The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.

  • customRoleArn (string) – Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry. This role must be in the same account as the registry that you are configuring.

Return type:

dict

Returns:

Response Syntax

{
    'ecrRepositoryPrefix': 'string',
    'registryId': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'credentialArn': 'string',
    'customRoleArn': 'string',
    'upstreamRepositoryPrefix': 'string'
}

Response Structure

  • (dict) –

    • ecrRepositoryPrefix (string) –

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

    • registryId (string) –

      The registry ID associated with the request.

    • updatedAt (datetime) –

      The date and time, in JavaScript date format, when the pull through cache rule was updated.

    • credentialArn (string) –

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

    • customRoleArn (string) –

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

    • upstreamRepositoryPrefix (string) –

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

Exceptions

  • ECR.Client.exceptions.ServerException

  • ECR.Client.exceptions.InvalidParameterException

  • ECR.Client.exceptions.ValidationException

  • ECR.Client.exceptions.UnableToAccessSecretException

  • ECR.Client.exceptions.PullThroughCacheRuleNotFoundException

  • ECR.Client.exceptions.SecretNotFoundException

  • ECR.Client.exceptions.UnableToDecryptSecretValueException