NAME
Paws::ECRPublic - Perl Interface to AWS Amazon Elastic Container Registry Public
SYNOPSIS
use Paws;
my $obj = Paws->service('ECRPublic');
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 Public
Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Amazon ECR provides both public and private registries to host your container images. You 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 public repositories with this API. For information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API Reference (https://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.html).
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/api.ecr-public-2020-10-30
METHODS
BatchCheckLayerAvailability
Each argument is described in detail in: Paws::ECRPublic::BatchCheckLayerAvailability
Returns: a Paws::ECRPublic::BatchCheckLayerAvailabilityResponse instance
Checks the availability of one or more image layers within a repository in a public registry. 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::ECRPublic::ImageIdentifier]
- RepositoryName => Str
- [RegistryId => Str]
Each argument is described in detail in: Paws::ECRPublic::BatchDeleteImage
Returns: a Paws::ECRPublic::BatchDeleteImageResponse instance
Deletes a list of specified images within a repository in a public registry. 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.
CompleteLayerUpload
Each argument is described in detail in: Paws::ECRPublic::CompleteLayerUpload
Returns: a Paws::ECRPublic::CompleteLayerUploadResponse instance
Informs Amazon ECR that the image layer upload has completed for a specified public 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
- [CatalogData => Paws::ECRPublic::RepositoryCatalogDataInput]
- [Tags => ArrayRef[Paws::ECRPublic::Tag]]
Each argument is described in detail in: Paws::ECRPublic::CreateRepository
Returns: a Paws::ECRPublic::CreateRepositoryResponse instance
Creates a repository in a public registry. 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.
DeleteRepository
Each argument is described in detail in: Paws::ECRPublic::DeleteRepository
Returns: a Paws::ECRPublic::DeleteRepositoryResponse instance
Deletes a repository in a public registry. If the repository contains images, you must either delete all images in the repository or use the force option which deletes all images on your behalf before deleting the repository.
DeleteRepositoryPolicy
Each argument is described in detail in: Paws::ECRPublic::DeleteRepositoryPolicy
Returns: a Paws::ECRPublic::DeleteRepositoryPolicyResponse instance
Deletes the repository policy associated with the specified repository.
DescribeImages
- RepositoryName => Str
- [ImageIds => ArrayRef[Paws::ECRPublic::ImageIdentifier]]
- [MaxResults => Int]
- [NextToken => Str]
- [RegistryId => Str]
Each argument is described in detail in: Paws::ECRPublic::DescribeImages
Returns: a Paws::ECRPublic::DescribeImagesResponse instance
Returns metadata about the images in a repository in a public registry.
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.
DescribeImageTags
Each argument is described in detail in: Paws::ECRPublic::DescribeImageTags
Returns: a Paws::ECRPublic::DescribeImageTagsResponse instance
Returns the image tag details for a repository in a public registry.
DescribeRegistries
Each argument is described in detail in: Paws::ECRPublic::DescribeRegistries
Returns: a Paws::ECRPublic::DescribeRegistriesResponse instance
Returns details for a public registry.
DescribeRepositories
Each argument is described in detail in: Paws::ECRPublic::DescribeRepositories
Returns: a Paws::ECRPublic::DescribeRepositoriesResponse instance
Describes repositories in a public registry.
GetAuthorizationToken
Each argument is described in detail in: Paws::ECRPublic::GetAuthorizationToken
Returns: a Paws::ECRPublic::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. This API requires the ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions.
GetRegistryCatalogData
Each argument is described in detail in: Paws::ECRPublic::GetRegistryCatalogData
Returns: a Paws::ECRPublic::GetRegistryCatalogDataResponse instance
Retrieves catalog metadata for a public registry.
GetRepositoryCatalogData
Each argument is described in detail in: Paws::ECRPublic::GetRepositoryCatalogData
Returns: a Paws::ECRPublic::GetRepositoryCatalogDataResponse instance
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
GetRepositoryPolicy
Each argument is described in detail in: Paws::ECRPublic::GetRepositoryPolicy
Returns: a Paws::ECRPublic::GetRepositoryPolicyResponse instance
Retrieves the repository policy for the specified repository.
InitiateLayerUpload
Each argument is described in detail in: Paws::ECRPublic::InitiateLayerUpload
Returns: a Paws::ECRPublic::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.
ListTagsForResource
Each argument is described in detail in: Paws::ECRPublic::ListTagsForResource
Returns: a Paws::ECRPublic::ListTagsForResourceResponse instance
List the tags for an Amazon ECR Public resource.
PutImage
- ImageManifest => Str
- RepositoryName => Str
- [ImageDigest => Str]
- [ImageManifestMediaType => Str]
- [ImageTag => Str]
- [RegistryId => Str]
Each argument is described in detail in: Paws::ECRPublic::PutImage
Returns: a Paws::ECRPublic::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.
PutRegistryCatalogData
Each argument is described in detail in: Paws::ECRPublic::PutRegistryCatalogData
Returns: a Paws::ECRPublic::PutRegistryCatalogDataResponse instance
Create or updates the catalog data for a public registry.
PutRepositoryCatalogData
- CatalogData => Paws::ECRPublic::RepositoryCatalogDataInput
- RepositoryName => Str
- [RegistryId => Str]
Each argument is described in detail in: Paws::ECRPublic::PutRepositoryCatalogData
Returns: a Paws::ECRPublic::PutRepositoryCatalogDataResponse instance
Creates or updates the catalog data for a repository in a public registry.
SetRepositoryPolicy
Each argument is described in detail in: Paws::ECRPublic::SetRepositoryPolicy
Returns: a Paws::ECRPublic::SetRepositoryPolicyResponse instance
Applies a repository policy to the specified public 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.
TagResource
- ResourceArn => Str
- Tags => ArrayRef[Paws::ECRPublic::Tag]
Each argument is described in detail in: Paws::ECRPublic::TagResource
Returns: a Paws::ECRPublic::TagResourceResponse instance
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
UntagResource
Each argument is described in detail in: Paws::ECRPublic::UntagResource
Returns: a Paws::ECRPublic::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::ECRPublic::UploadLayerPart
Returns: a Paws::ECRPublic::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, [ImageIds => ArrayRef[Paws::ECRPublic::ImageIdentifier], MaxResults => Int, NextToken => Str, RegistryId => Str])
DescribeAllImages(RepositoryName => Str, [ImageIds => ArrayRef[Paws::ECRPublic::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::ECRPublic::DescribeImagesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
DescribeAllImageTags(sub { },RepositoryName => Str, [MaxResults => Int, NextToken => Str, RegistryId => Str])
DescribeAllImageTags(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 :
- imageTagDetails, passing the object as the first parameter, and the string 'imageTagDetails' as the second parameter If not, it will return a a Paws::ECRPublic::DescribeImageTagsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
DescribeAllRegistries(sub { },[MaxResults => Int, NextToken => Str])
DescribeAllRegistries([MaxResults => Int, NextToken => Str])
If passed a sub as first parameter, it will call the sub for each element found in :
- registries, passing the object as the first parameter, and the string 'registries' as the second parameter If not, it will return a a Paws::ECRPublic::DescribeRegistriesResponse 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::ECRPublic::DescribeRepositoriesResponse 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