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 Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/api.ecr-2015-09-21
METHODS
BatchCheckLayerAvailability
Each argument is described in detail in: Paws::ECR::BatchCheckLayerAvailability
Returns: a Paws::ECR::BatchCheckLayerAvailabilityResponse instance
Checks the availability of one or more image layers in a repository.
When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used 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 repository. Images are specified with either an 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 an image. Images are specified with either an imageTag or imageDigest.
When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
CompleteLayerUpload
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.
When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used 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
- [EncryptionConfiguration => Paws::ECR::EncryptionConfiguration]
- [ImageScanningConfiguration => Paws::ECR::ImageScanningConfiguration]
- [ImageTagMutability => Str]
- [Tags => ArrayRef[Paws::ECR::Tag]]
Each argument is described in detail in: Paws::ECR::CreateRepository
Returns: a Paws::ECR::CreateRepositoryResponse instance
Creates a repository. For more information, see Amazon ECR Repositories (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html) in the Amazon Elastic Container Registry User Guide.
DeleteLifecyclePolicy
Each argument is described in detail in: Paws::ECR::DeleteLifecyclePolicy
Returns: a Paws::ECR::DeleteLifecyclePolicyResponse instance
Deletes the lifecycle policy associated with the specified repository.
DeleteRegistryPolicy
Each argument is described in detail in: Paws::ECR::DeleteRegistryPolicy
Returns: a Paws::ECR::DeleteRegistryPolicyResponse instance
Deletes the registry permissions policy.
DeleteRepository
Each argument is described in detail in: Paws::ECR::DeleteRepository
Returns: a Paws::ECR::DeleteRepositoryResponse instance
Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force option to delete the repository.
DeleteRepositoryPolicy
Each argument is described in detail in: Paws::ECR::DeleteRepositoryPolicy
Returns: a Paws::ECR::DeleteRepositoryPolicyResponse instance
Deletes the repository policy associated with the 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.
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.
DescribeImageScanFindings
- ImageId => Paws::ECR::ImageIdentifier
- RepositoryName => Str
- [MaxResults => Int]
- [NextToken => Str]
- [RegistryId => Str]
Each argument is described in detail in: Paws::ECR::DescribeImageScanFindings
Returns: a Paws::ECR::DescribeImageScanFindingsResponse instance
Returns the scan findings for the specified image.
DescribeRegistry
Each argument is described in detail in: Paws::ECR::DescribeRegistry
Returns: a Paws::ECR::DescribeRegistryResponse instance
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
DescribeRepositories
Each argument is described in detail in: Paws::ECR::DescribeRepositories
Returns: a Paws::ECR::DescribeRepositoriesResponse instance
Describes image repositories in a registry.
GetAuthorizationToken
Each argument is described in detail in: Paws::ECR::GetAuthorizationToken
Returns: a Paws::ECR::GetAuthorizationTokenResponse instance
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken returned 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 get-login-password command that simplifies the login process. For more information, see Registry Authentication (https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth) in the Amazon Elastic Container Registry User Guide.
GetDownloadUrlForLayer
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.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
GetLifecyclePolicy
Each argument is described in detail in: Paws::ECR::GetLifecyclePolicy
Returns: a Paws::ECR::GetLifecyclePolicyResponse instance
Retrieves the lifecycle policy for the specified repository.
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 lifecycle policy preview request for the specified repository.
GetRegistryPolicy
Each argument is described in detail in: Paws::ECR::GetRegistryPolicy
Returns: a Paws::ECR::GetRegistryPolicyResponse instance
Retrieves the permissions policy for a registry.
GetRepositoryPolicy
Each argument is described in detail in: Paws::ECR::GetRepositoryPolicy
Returns: a Paws::ECR::GetRepositoryPolicyResponse instance
Retrieves the repository policy for the specified repository.
InitiateLayerUpload
Each argument is described in detail in: Paws::ECR::InitiateLayerUpload
Returns: a Paws::ECR::InitiateLayerUploadResponse instance
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used 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 the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. 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
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
- [ImageDigest => Str]
- [ImageManifestMediaType => 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.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
PutImageScanningConfiguration
- ImageScanningConfiguration => Paws::ECR::ImageScanningConfiguration
- RepositoryName => Str
- [RegistryId => Str]
Each argument is described in detail in: Paws::ECR::PutImageScanningConfiguration
Returns: a Paws::ECR::PutImageScanningConfigurationResponse instance
Updates the image scanning configuration for the specified repository.
PutImageTagMutability
Each argument is described in detail in: Paws::ECR::PutImageTagMutability
Returns: a Paws::ECR::PutImageTagMutabilityResponse instance
Updates the image tag mutability settings for the specified repository. For more information, see Image Tag Mutability (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html) in the Amazon Elastic Container Registry User Guide.
PutLifecyclePolicy
Each argument is described in detail in: Paws::ECR::PutLifecyclePolicy
Returns: a Paws::ECR::PutLifecyclePolicyResponse instance
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template (https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html).
PutRegistryPolicy
Each argument is described in detail in: Paws::ECR::PutRegistryPolicy
Returns: a Paws::ECR::PutRegistryPolicyResponse instance
Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another AWS account and is used when configuring cross-account replication. For more information, see Registry permissions (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) in the Amazon Elastic Container Registry User Guide.
PutReplicationConfiguration
- ReplicationConfiguration => Paws::ECR::ReplicationConfiguration
Each argument is described in detail in: Paws::ECR::PutReplicationConfiguration
Returns: a Paws::ECR::PutReplicationConfigurationResponse instance
Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using Service-Linked Roles for Amazon ECR (https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html) in the Amazon Elastic Container Registry User Guide.
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
SetRepositoryPolicy
Each argument is described in detail in: Paws::ECR::SetRepositoryPolicy
Returns: a Paws::ECR::SetRepositoryPolicyResponse instance
Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository Policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html) in the Amazon Elastic Container Registry User Guide.
StartImageScan
- ImageId => Paws::ECR::ImageIdentifier
- RepositoryName => Str
- [RegistryId => Str]
Each argument is described in detail in: Paws::ECR::StartImageScan
Returns: a Paws::ECR::StartImageScanResponse instance
Starts an image vulnerability scan. An image scan can only be started once per day on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image Scanning (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) in the Amazon Elastic Container Registry User Guide.
StartLifecyclePolicyPreview
Each argument is described in detail in: Paws::ECR::StartLifecyclePolicyPreview
Returns: a Paws::ECR::StartLifecyclePolicyPreviewResponse instance
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.
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
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.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used 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.
DescribeAllImageScanFindings(sub { },ImageId => Paws::ECR::ImageIdentifier, RepositoryName => Str, [MaxResults => Int, NextToken => Str, RegistryId => Str])
DescribeAllImageScanFindings(ImageId => Paws::ECR::ImageIdentifier, RepositoryName => Str, [MaxResults => Int, NextToken => Str, RegistryId => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- imageScanFindings.findings, passing the object as the first parameter, and the string 'imageScanFindings.findings' as the second parameter If not, it will return a a Paws::ECR::DescribeImageScanFindingsResponse 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.
GetAllLifecyclePolicyPreview(sub { },RepositoryName => Str, [Filter => Paws::ECR::LifecyclePolicyPreviewFilter, ImageIds => ArrayRef[Paws::ECR::ImageIdentifier], MaxResults => Int, NextToken => Str, RegistryId => Str])
GetAllLifecyclePolicyPreview(RepositoryName => Str, [Filter => Paws::ECR::LifecyclePolicyPreviewFilter, 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 :
- previewResults, passing the object as the first parameter, and the string 'previewResults' as the second parameter If not, it will return a a Paws::ECR::GetLifecyclePolicyPreviewResponse 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