cognitect.aws.ecr-public.docs.edn Maven / Gradle / Ivy
{:GetRegistryCatalogData {:documentation "Retrieves catalog metadata for a public registry.
", :response {:registryCatalogData {:displayName string}}}, :CreateRepository {:documentation "Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
", :request {:repositoryName string, :catalogData {:description string, :architectures [:seq-of string], :operatingSystems [:seq-of string], :logoImageBlob blob, :aboutText string, :usageText string}, :tags [:seq-of {:Key string, :Value string}]}, :required [:repositoryName], :response {:repository {:repositoryArn string, :registryId string, :repositoryName string, :repositoryUri string, :createdAt timestamp}, :catalogData {:description string, :architectures [:seq-of string], :operatingSystems [:seq-of string], :logoUrl string, :aboutText string, :usageText string, :marketplaceCertified boolean}}}, :ListTagsForResource {:documentation "List the tags for an Amazon ECR Public resource.
", :request {:resourceArn string}, :required [:resourceArn], :response {:tags [:seq-of {:Key string, :Value string}]}}, :TagResource {:documentation "Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.
", :request {:resourceArn string, :tags [:seq-of {:Key string, :Value string}]}, :required [:resourceArn :tags]}, :GetRepositoryPolicy {:documentation "Retrieves the repository policy for the specified repository.
", :request {:registryId string, :repositoryName string}, :required [:repositoryName], :response {:registryId string, :repositoryName string, :policyText string}}, :UntagResource {:documentation "Deletes specified tags from a resource.
", :request {:resourceArn string, :tagKeys [:seq-of string]}, :required [:resourceArn :tagKeys]}, :UploadLayerPart {:documentation "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 (about 20MB). The UploadLayerPart API is called once for 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.
", :request {:registryId string, :repositoryName string, :uploadId string, :partFirstByte long, :partLastByte long, :layerPartBlob blob}, :required [:repositoryName :uploadId :partFirstByte :partLastByte :layerPartBlob], :response {:registryId string, :repositoryName string, :uploadId string, :lastByteReceived long}}, :CompleteLayerUpload {:documentation "Informs Amazon ECR that the image layer upload is complete 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 for each new image layer to verify that the upload is complete.
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.
", :request {:registryId string, :repositoryName string, :uploadId string, :layerDigests [:seq-of string]}, :required [:repositoryName :uploadId :layerDigests], :response {:registryId string, :repositoryName string, :uploadId string, :layerDigest string}}, :PutImage {:documentation "Creates or updates the image manifest and tags that are 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 that are 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.
", :request {:registryId string, :repositoryName string, :imageManifest string, :imageManifestMediaType string, :imageTag string, :imageDigest string}, :required [:repositoryName :imageManifest], :response {:image {:registryId string, :repositoryName string, :imageId {:imageDigest string, :imageTag string}, :imageManifest string, :imageManifestMediaType string}}}, :BatchCheckLayerAvailability {:documentation "Checks the availability of one or more image layers that are 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.
", :request {:registryId string, :repositoryName string, :layerDigests [:seq-of string]}, :required [:repositoryName :layerDigests], :response {:layers [:seq-of {:layerDigest string, :layerAvailability [:one-of ["AVAILABLE" "UNAVAILABLE"]], :layerSize long, :mediaType string}], :failures [:seq-of {:layerDigest string, :failureCode [:one-of ["InvalidLayerDigest" "MissingLayerDigest"]], :failureReason string}]}}, :GetAuthorizationToken {:documentation "Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can use it 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.
", :response {:authorizationData {:authorizationToken string, :expiresAt timestamp}}}, :PutRepositoryCatalogData {:documentation "Creates or updates the catalog data for a repository in a public registry.
", :request {:registryId string, :repositoryName string, :catalogData {:description string, :architectures [:seq-of string], :operatingSystems [:seq-of string], :logoImageBlob blob, :aboutText string, :usageText string}}, :required [:repositoryName :catalogData], :response {:catalogData {:description string, :architectures [:seq-of string], :operatingSystems [:seq-of string], :logoUrl string, :aboutText string, :usageText string, :marketplaceCertified boolean}}}, :DeleteRepository {:documentation "Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the force option. This option deletes all images on your behalf before deleting the repository.
", :request {:registryId string, :repositoryName string, :force boolean}, :required [:repositoryName], :response {:repository {:repositoryArn string, :registryId string, :repositoryName string, :repositoryUri string, :createdAt timestamp}}}, :PutRegistryCatalogData {:documentation "Create or update the catalog data for a public registry.
", :request {:displayName string}, :response {:registryCatalogData {:displayName string}}}, :InitiateLayerUpload {:documentation "Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads 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.
", :request {:registryId string, :repositoryName string}, :required [:repositoryName], :response {:uploadId string, :partSize long}}, :BatchDeleteImage {:documentation "Deletes a list of specified images that are 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 digest of the image in your request.
", :request {:registryId string, :repositoryName string, :imageIds [:seq-of {:imageDigest string, :imageTag string}]}, :required [:repositoryName :imageIds], :response {:imageIds [:seq-of {:imageDigest string, :imageTag string}], :failures [:seq-of {:imageId {:imageDigest string, :imageTag string}, :failureCode [:one-of ["InvalidImageDigest" "InvalidImageTag" "ImageTagDoesNotMatchDigest" "ImageNotFound" "MissingDigestAndTag" "ImageReferencedByManifestList" "KmsError"]], :failureReason string}]}}, :GetRepositoryCatalogData {:documentation "Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
", :request {:registryId string, :repositoryName string}, :required [:repositoryName], :response {:catalogData {:description string, :architectures [:seq-of string], :operatingSystems [:seq-of string], :logoUrl string, :aboutText string, :usageText string, :marketplaceCertified boolean}}}, :DescribeRepositories {:documentation "Describes repositories that are in a public registry.
", :request {:registryId string, :repositoryNames [:seq-of string], :nextToken string, :maxResults integer}, :response {:repositories [:seq-of {:repositoryArn string, :registryId string, :repositoryName string, :repositoryUri string, :createdAt timestamp}], :nextToken string}}, :SetRepositoryPolicy {:documentation "Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
", :request {:registryId string, :repositoryName string, :policyText string, :force boolean}, :required [:repositoryName :policyText], :response {:registryId string, :repositoryName string, :policyText string}}, :DescribeImages {:documentation "Returns metadata that's related to 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. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages.
", :request {:registryId string, :repositoryName string, :imageIds [:seq-of {:imageDigest string, :imageTag string}], :nextToken string, :maxResults integer}, :required [:repositoryName], :response {:imageDetails [:seq-of {:registryId string, :repositoryName string, :imageDigest string, :imageTags [:seq-of string], :imageSizeInBytes long, :imagePushedAt timestamp, :imageManifestMediaType string, :artifactMediaType string}], :nextToken string}}, :DeleteRepositoryPolicy {:documentation "Deletes the repository policy that's associated with the specified repository.
", :request {:registryId string, :repositoryName string}, :required [:repositoryName], :response {:registryId string, :repositoryName string, :policyText string}}, :DescribeRegistries {:documentation "Returns details for a public registry.
", :request {:nextToken string, :maxResults integer}, :response {:registries [:seq-of {:registryId string, :registryArn string, :registryUri string, :verified boolean, :aliases [:seq-of {:name string, :status [:one-of ["ACTIVE" "PENDING" "REJECTED"]], :primaryRegistryAlias boolean, :defaultRegistryAlias boolean}]}], :nextToken string}}, :DescribeImageTags {:documentation "Returns the image tag details for a repository in a public registry.
", :request {:registryId string, :repositoryName string, :nextToken string, :maxResults integer}, :required [:repositoryName], :response {:imageTagDetails [:seq-of {:imageTag string, :createdAt timestamp, :imageDetail {:imageDigest string, :imageSizeInBytes long, :imagePushedAt timestamp, :imageManifestMediaType string, :artifactMediaType string}}], :nextToken string}}}