ECR / Client / start_lifecycle_policy_preview

start_lifecycle_policy_preview

ECR.Client.start_lifecycle_policy_preview(**kwargs)

Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.

See also: AWS API Documentation

Request Syntax

response = client.start_lifecycle_policy_preview(
    registryId='string',
    repositoryName='string',
    lifecyclePolicyText='string'
)

Parameters:

• registryId (string) – The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

• repositoryName (string) –

  [REQUIRED]

  The name of the repository to be evaluated.

• lifecyclePolicyText (string) – The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.

Return type:

dict

Returns:

Response Syntax

{
    'registryId': 'string',
    'repositoryName': 'string',
    'lifecyclePolicyText': 'string',
    'status': 'IN_PROGRESS'|'COMPLETE'|'EXPIRED'|'FAILED'
}

Response Structure

• (dict) –

  • registryId (string) –

    The registry ID associated with the request.

  • repositoryName (string) –

    The repository name associated with the request.

  • lifecyclePolicyText (string) –

    The JSON repository policy text.

  • status (string) –

    The status of the lifecycle policy preview request.

Exceptions

• ECR.Client.exceptions.ServerException

• ECR.Client.exceptions.InvalidParameterException

• ECR.Client.exceptions.RepositoryNotFoundException

• ECR.Client.exceptions.LifecyclePolicyNotFoundException

• ECR.Client.exceptions.LifecyclePolicyPreviewInProgressException

• ECR.Client.exceptions.ValidationException