NAME

Paws::ECR - Perl Interface to AWS Amazon EC2 Container Registry

SYNOPSIS

  use Paws;

  my $obj = Paws->service('ECR');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon Elastic Container Registry (Amazon ECR) is a managed Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21

METHODS

BatchCheckLayerAvailability

LayerDigests => ArrayRef[Str|Undef]
RepositoryName => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::BatchCheckLayerAvailability

Returns: a Paws::ECR::BatchCheckLayerAvailabilityResponse instance

Check the availability of multiple image layers in a specified registry and repository.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

BatchDeleteImage

ImageIds => ArrayRef[Paws::ECR::ImageIdentifier]
RepositoryName => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::BatchDeleteImage

Returns: a Paws::ECR::BatchDeleteImageResponse instance

Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest.

You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.

You can completely delete an image (and all of its tags) by specifying the image's digest in your request.

BatchGetImage

ImageIds => ArrayRef[Paws::ECR::ImageIdentifier]
RepositoryName => Str
[AcceptedMediaTypes => ArrayRef[Str|Undef]]
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::BatchGetImage

Returns: a Paws::ECR::BatchGetImageResponse instance

Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.

CompleteLayerUpload

LayerDigests => ArrayRef[Str|Undef]
RepositoryName => Str
UploadId => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::CompleteLayerUpload

Returns: a Paws::ECR::CompleteLayerUploadResponse instance

Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

CreateRepository

RepositoryName => Str
[Tags => ArrayRef[Paws::ECR::Tag]]

Each argument is described in detail in: Paws::ECR::CreateRepository

Returns: a Paws::ECR::CreateRepositoryResponse instance

Creates an image repository.

DeleteLifecyclePolicy

RepositoryName => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::DeleteLifecyclePolicy

Returns: a Paws::ECR::DeleteLifecyclePolicyResponse instance

Deletes the specified lifecycle policy.

DeleteRepository

RepositoryName => Str
[Force => Bool]
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::DeleteRepository

Returns: a Paws::ECR::DeleteRepositoryResponse instance

Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.

DeleteRepositoryPolicy

RepositoryName => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::DeleteRepositoryPolicy

Returns: a Paws::ECR::DeleteRepositoryPolicyResponse instance

Deletes the repository policy from a specified repository.

DescribeImages

RepositoryName => Str
[Filter => Paws::ECR::DescribeImagesFilter]
[ImageIds => ArrayRef[Paws::ECR::ImageIdentifier]]
[MaxResults => Int]
[NextToken => Str]
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::DescribeImages

Returns: a Paws::ECR::DescribeImagesResponse instance

Returns metadata about the images in a repository, including image size, image tags, and creation date.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

DescribeRepositories

[MaxResults => Int]
[NextToken => Str]
[RegistryId => Str]
[RepositoryNames => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::ECR::DescribeRepositories

Returns: a Paws::ECR::DescribeRepositoriesResponse instance

Describes image repositories in a registry.

GetAuthorizationToken

[RegistryIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::ECR::GetAuthorizationToken

Returns: a Paws::ECR::GetAuthorizationTokenResponse instance

Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.

The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process.

GetDownloadUrlForLayer

LayerDigest => Str
RepositoryName => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::GetDownloadUrlForLayer

Returns: a Paws::ECR::GetDownloadUrlForLayerResponse instance

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

GetLifecyclePolicy

RepositoryName => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::GetLifecyclePolicy

Returns: a Paws::ECR::GetLifecyclePolicyResponse instance

Retrieves the specified lifecycle policy.

GetLifecyclePolicyPreview

RepositoryName => Str
[Filter => Paws::ECR::LifecyclePolicyPreviewFilter]
[ImageIds => ArrayRef[Paws::ECR::ImageIdentifier]]
[MaxResults => Int]
[NextToken => Str]
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::GetLifecyclePolicyPreview

Returns: a Paws::ECR::GetLifecyclePolicyPreviewResponse instance

Retrieves the results of the specified lifecycle policy preview request.

GetRepositoryPolicy

RepositoryName => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::GetRepositoryPolicy

Returns: a Paws::ECR::GetRepositoryPolicyResponse instance

Retrieves the repository policy for a specified repository.

InitiateLayerUpload

RepositoryName => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::InitiateLayerUpload

Returns: a Paws::ECR::InitiateLayerUploadResponse instance

Notify Amazon ECR that you intend to upload an image layer.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

ListImages

RepositoryName => Str
[Filter => Paws::ECR::ListImagesFilter]
[MaxResults => Int]
[NextToken => Str]
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::ListImages

Returns: a Paws::ECR::ListImagesResponse instance

Lists all the image IDs for a given repository.

You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::ECR::ListTagsForResource

Returns: a Paws::ECR::ListTagsForResourceResponse instance

List the tags for an Amazon ECR resource.

PutImage

ImageManifest => Str
RepositoryName => Str
[ImageTag => Str]
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::PutImage

Returns: a Paws::ECR::PutImageResponse instance

Creates or updates the image manifest and tags associated with an image.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

PutLifecyclePolicy

LifecyclePolicyText => Str
RepositoryName => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::PutLifecyclePolicy

Returns: a Paws::ECR::PutLifecyclePolicyResponse instance

Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template (http://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).

SetRepositoryPolicy

PolicyText => Str
RepositoryName => Str
[Force => Bool]
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::SetRepositoryPolicy

Returns: a Paws::ECR::SetRepositoryPolicyResponse instance

Applies a repository policy on a specified repository to control access permissions.

StartLifecyclePolicyPreview

RepositoryName => Str
[LifecyclePolicyText => Str]
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::StartLifecyclePolicyPreview

Returns: a Paws::ECR::StartLifecyclePolicyPreviewResponse instance

Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::ECR::Tag]

Each argument is described in detail in: Paws::ECR::TagResource

Returns: a Paws::ECR::TagResourceResponse instance

Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ECR::UntagResource

Returns: a Paws::ECR::UntagResourceResponse instance

Deletes specified tags from a resource.

UploadLayerPart

LayerPartBlob => Str
PartFirstByte => Int
PartLastByte => Int
RepositoryName => Str
UploadId => Str
[RegistryId => Str]

Each argument is described in detail in: Paws::ECR::UploadLayerPart

Returns: a Paws::ECR::UploadLayerPartResponse instance

Uploads an image layer part to Amazon ECR.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

DescribeAllImages(sub { },RepositoryName => Str, [Filter => Paws::ECR::DescribeImagesFilter, ImageIds => ArrayRef[Paws::ECR::ImageIdentifier], MaxResults => Int, NextToken => Str, RegistryId => Str])

DescribeAllImages(RepositoryName => Str, [Filter => Paws::ECR::DescribeImagesFilter, ImageIds => ArrayRef[Paws::ECR::ImageIdentifier], MaxResults => Int, NextToken => Str, RegistryId => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - imageDetails, passing the object as the first parameter, and the string 'imageDetails' as the second parameter 

If not, it will return a a Paws::ECR::DescribeImagesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllRepositories(sub { },[MaxResults => Int, NextToken => Str, RegistryId => Str, RepositoryNames => ArrayRef[Str|Undef]])

DescribeAllRepositories([MaxResults => Int, NextToken => Str, RegistryId => Str, RepositoryNames => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - repositories, passing the object as the first parameter, and the string 'repositories' as the second parameter 

If not, it will return a a Paws::ECR::DescribeRepositoriesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllImages(sub { },RepositoryName => Str, [Filter => Paws::ECR::ListImagesFilter, MaxResults => Int, NextToken => Str, RegistryId => Str])

ListAllImages(RepositoryName => Str, [Filter => Paws::ECR::ListImagesFilter, MaxResults => Int, NextToken => Str, RegistryId => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - imageIds, passing the object as the first parameter, and the string 'imageIds' as the second parameter 

If not, it will return a a Paws::ECR::ListImagesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues