ECR / Client / validate_pull_through_cache_rule

validate_pull_through_cache_rule#

ECR.Client.validate_pull_through_cache_rule(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.validate_pull_through_cache_rule(
    ecrRepositoryPrefix='string',
    registryId='string'
)
Parameters:

  • ecrRepositoryPrefix (string) –

    [REQUIRED]

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

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

Return type:

dict

Returns:

Response Syntax

{
    'ecrRepositoryPrefix': 'string',
    'registryId': 'string',
    'upstreamRegistryUrl': 'string',
    'credentialArn': 'string',
    'isValid': True|False,
    'failure': '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.

    • upstreamRegistryUrl (string) –

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

    • credentialArn (string) –

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

    • isValid (boolean) –

      Whether or not the pull through cache rule was validated. If true, Amazon ECR was able to reach the upstream registry and authentication was successful. If false, there was an issue and validation failed. The failure reason indicates the cause.

    • failure (string) –

      The reason the validation failed. For more details about possible causes and how to address them, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.

Exceptions

  • ECR.Client.exceptions.ServerException

  • ECR.Client.exceptions.InvalidParameterException

  • ECR.Client.exceptions.ValidationException

  • ECR.Client.exceptions.PullThroughCacheRuleNotFoundException