/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the ecr-public-2020-10-30.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.ECRPublic.Model;
namespace Amazon.ECRPublic
{
///
/// Interface for accessing ECRPublic
///
/// Amazon Elastic Container Registry Public
///
/// Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container
/// image registry service. Amazon ECR provides both public and private registries to
/// host your container images. You can use the Docker CLI or your 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.
///
///
public partial interface IAmazonECRPublic : IAmazonService, IDisposable
{
///
/// Paginators for the service
///
IECRPublicPaginatorFactory Paginators { get; }
#region BatchCheckLayerAvailability
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the BatchCheckLayerAvailability service method.
///
/// The response from the BatchCheckLayerAvailability service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for BatchCheckLayerAvailability Operation
BatchCheckLayerAvailabilityResponse BatchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request);
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the BatchCheckLayerAvailability service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the BatchCheckLayerAvailability service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for BatchCheckLayerAvailability Operation
Task BatchCheckLayerAvailabilityAsync(BatchCheckLayerAvailabilityRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region BatchDeleteImage
///
/// 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.
///
///
/// Container for the necessary parameters to execute the BatchDeleteImage service method.
///
/// The response from the BatchDeleteImage service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for BatchDeleteImage Operation
BatchDeleteImageResponse BatchDeleteImage(BatchDeleteImageRequest request);
///
/// 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.
///
///
/// Container for the necessary parameters to execute the BatchDeleteImage service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the BatchDeleteImage service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for BatchDeleteImage Operation
Task BatchDeleteImageAsync(BatchDeleteImageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CompleteLayerUpload
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the CompleteLayerUpload service method.
///
/// The response from the CompleteLayerUpload service method, as returned by ECRPublic.
///
/// The specified layer upload doesn't contain any layer parts.
///
///
/// The layer digest calculation performed by Amazon ECR when the image layer doesn't
/// match the digest specified.
///
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The image layer already exists in the associated repository.
///
///
/// Layer parts must be at least 5 MiB in size.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
///
/// The upload can't be found, or the specified upload ID isn't valid for this repository.
///
/// REST API Reference for CompleteLayerUpload Operation
CompleteLayerUploadResponse CompleteLayerUpload(CompleteLayerUploadRequest request);
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the CompleteLayerUpload service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CompleteLayerUpload service method, as returned by ECRPublic.
///
/// The specified layer upload doesn't contain any layer parts.
///
///
/// The layer digest calculation performed by Amazon ECR when the image layer doesn't
/// match the digest specified.
///
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The image layer already exists in the associated repository.
///
///
/// Layer parts must be at least 5 MiB in size.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
///
/// The upload can't be found, or the specified upload ID isn't valid for this repository.
///
/// REST API Reference for CompleteLayerUpload Operation
Task CompleteLayerUploadAsync(CompleteLayerUploadRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateRepository
///
/// Creates a repository in a public registry. For more information, see Amazon
/// ECR repositories in the Amazon Elastic Container Registry User Guide.
///
/// Container for the necessary parameters to execute the CreateRepository service method.
///
/// The response from the CreateRepository service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// An invalid parameter has been specified. Tag keys can have a maximum character length
/// of 128 characters, and tag values can have a maximum length of 256 characters.
///
///
/// The operation didn't succeed because it would have exceeded a service limit for your
/// account. For more information, see Amazon
/// ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
///
///
/// The specified repository already exists in the specified registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The list of tags on the repository is over the limit. The maximum number of tags that
/// can be applied to a repository is 50.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for CreateRepository Operation
CreateRepositoryResponse CreateRepository(CreateRepositoryRequest request);
///
/// Creates a repository in a public registry. For more information, see Amazon
/// ECR repositories in the Amazon Elastic Container Registry User Guide.
///
/// Container for the necessary parameters to execute the CreateRepository service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateRepository service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// An invalid parameter has been specified. Tag keys can have a maximum character length
/// of 128 characters, and tag values can have a maximum length of 256 characters.
///
///
/// The operation didn't succeed because it would have exceeded a service limit for your
/// account. For more information, see Amazon
/// ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
///
///
/// The specified repository already exists in the specified registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The list of tags on the repository is over the limit. The maximum number of tags that
/// can be applied to a repository is 50.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for CreateRepository Operation
Task CreateRepositoryAsync(CreateRepositoryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteRepository
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteRepository service method.
///
/// The response from the DeleteRepository service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository contains images. To delete a repository that contains images,
/// you must force the deletion with the force
parameter.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DeleteRepository Operation
DeleteRepositoryResponse DeleteRepository(DeleteRepositoryRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteRepository service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteRepository service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository contains images. To delete a repository that contains images,
/// you must force the deletion with the force
parameter.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DeleteRepository Operation
Task DeleteRepositoryAsync(DeleteRepositoryRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteRepositoryPolicy
///
/// Deletes the repository policy that's associated with the specified repository.
///
/// Container for the necessary parameters to execute the DeleteRepositoryPolicy service method.
///
/// The response from the DeleteRepositoryPolicy service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// The specified repository and registry combination doesn't have an associated repository
/// policy.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DeleteRepositoryPolicy Operation
DeleteRepositoryPolicyResponse DeleteRepositoryPolicy(DeleteRepositoryPolicyRequest request);
///
/// Deletes the repository policy that's associated with the specified repository.
///
/// Container for the necessary parameters to execute the DeleteRepositoryPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteRepositoryPolicy service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// The specified repository and registry combination doesn't have an associated repository
/// policy.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DeleteRepositoryPolicy Operation
Task DeleteRepositoryPolicyAsync(DeleteRepositoryPolicyRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeImages
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the DescribeImages service method.
///
/// The response from the DescribeImages service method, as returned by ECRPublic.
///
/// The image requested doesn't exist in the specified repository.
///
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DescribeImages Operation
DescribeImagesResponse DescribeImages(DescribeImagesRequest request);
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the DescribeImages service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeImages service method, as returned by ECRPublic.
///
/// The image requested doesn't exist in the specified repository.
///
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DescribeImages Operation
Task DescribeImagesAsync(DescribeImagesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeImageTags
///
/// Returns the image tag details for a repository in a public registry.
///
/// Container for the necessary parameters to execute the DescribeImageTags service method.
///
/// The response from the DescribeImageTags service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DescribeImageTags Operation
DescribeImageTagsResponse DescribeImageTags(DescribeImageTagsRequest request);
///
/// Returns the image tag details for a repository in a public registry.
///
/// Container for the necessary parameters to execute the DescribeImageTags service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeImageTags service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DescribeImageTags Operation
Task DescribeImageTagsAsync(DescribeImageTagsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeRegistries
///
/// Returns details for a public registry.
///
/// Container for the necessary parameters to execute the DescribeRegistries service method.
///
/// The response from the DescribeRegistries service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DescribeRegistries Operation
DescribeRegistriesResponse DescribeRegistries(DescribeRegistriesRequest request);
///
/// Returns details for a public registry.
///
/// Container for the necessary parameters to execute the DescribeRegistries service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeRegistries service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DescribeRegistries Operation
Task DescribeRegistriesAsync(DescribeRegistriesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeRepositories
///
/// Describes repositories that are in a public registry.
///
/// Container for the necessary parameters to execute the DescribeRepositories service method.
///
/// The response from the DescribeRepositories service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DescribeRepositories Operation
DescribeRepositoriesResponse DescribeRepositories(DescribeRepositoriesRequest request);
///
/// Describes repositories that are in a public registry.
///
/// Container for the necessary parameters to execute the DescribeRepositories service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeRepositories service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for DescribeRepositories Operation
Task DescribeRepositoriesAsync(DescribeRepositoriesRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetAuthorizationToken
///
/// 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.
///
/// Container for the necessary parameters to execute the GetAuthorizationToken service method.
///
/// The response from the GetAuthorizationToken service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for GetAuthorizationToken Operation
GetAuthorizationTokenResponse GetAuthorizationToken(GetAuthorizationTokenRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the GetAuthorizationToken service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetAuthorizationToken service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for GetAuthorizationToken Operation
Task GetAuthorizationTokenAsync(GetAuthorizationTokenRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetRegistryCatalogData
///
/// Retrieves catalog metadata for a public registry.
///
/// Container for the necessary parameters to execute the GetRegistryCatalogData service method.
///
/// The response from the GetRegistryCatalogData service method, as returned by ECRPublic.
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for GetRegistryCatalogData Operation
GetRegistryCatalogDataResponse GetRegistryCatalogData(GetRegistryCatalogDataRequest request);
///
/// Retrieves catalog metadata for a public registry.
///
/// Container for the necessary parameters to execute the GetRegistryCatalogData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetRegistryCatalogData service method, as returned by ECRPublic.
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for GetRegistryCatalogData Operation
Task GetRegistryCatalogDataAsync(GetRegistryCatalogDataRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetRepositoryCatalogData
///
/// Retrieve catalog metadata for a repository in a public registry. This metadata is
/// displayed publicly in the Amazon ECR Public Gallery.
///
/// Container for the necessary parameters to execute the GetRepositoryCatalogData service method.
///
/// The response from the GetRepositoryCatalogData service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The repository catalog data doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for GetRepositoryCatalogData Operation
GetRepositoryCatalogDataResponse GetRepositoryCatalogData(GetRepositoryCatalogDataRequest request);
///
/// Retrieve catalog metadata for a repository in a public registry. This metadata is
/// displayed publicly in the Amazon ECR Public Gallery.
///
/// Container for the necessary parameters to execute the GetRepositoryCatalogData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetRepositoryCatalogData service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The repository catalog data doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for GetRepositoryCatalogData Operation
Task GetRepositoryCatalogDataAsync(GetRepositoryCatalogDataRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetRepositoryPolicy
///
/// Retrieves the repository policy for the specified repository.
///
/// Container for the necessary parameters to execute the GetRepositoryPolicy service method.
///
/// The response from the GetRepositoryPolicy service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// The specified repository and registry combination doesn't have an associated repository
/// policy.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for GetRepositoryPolicy Operation
GetRepositoryPolicyResponse GetRepositoryPolicy(GetRepositoryPolicyRequest request);
///
/// Retrieves the repository policy for the specified repository.
///
/// Container for the necessary parameters to execute the GetRepositoryPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetRepositoryPolicy service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// The specified repository and registry combination doesn't have an associated repository
/// policy.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for GetRepositoryPolicy Operation
Task GetRepositoryPolicyAsync(GetRepositoryPolicyRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region InitiateLayerUpload
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the InitiateLayerUpload service method.
///
/// The response from the InitiateLayerUpload service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for InitiateLayerUpload Operation
InitiateLayerUploadResponse InitiateLayerUpload(InitiateLayerUploadRequest request);
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the InitiateLayerUpload service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the InitiateLayerUpload service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for InitiateLayerUpload Operation
Task InitiateLayerUploadAsync(InitiateLayerUploadRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// List the tags for an Amazon ECR Public resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// List the tags for an Amazon ECR Public resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutImage
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the PutImage service method.
///
/// The response from the PutImage service method, as returned by ECRPublic.
///
/// The specified image has already been pushed, and there were no changes to the manifest
/// or image tag after the last push.
///
///
/// The specified image digest doesn't match the digest that Amazon ECR calculated for
/// the image.
///
///
/// The specified image is tagged with a tag that already exists. The repository is configured
/// for tag immutability.
///
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified layers can't be found, or the specified layer isn't valid for this repository.
///
///
/// The operation didn't succeed because it would have exceeded a service limit for your
/// account. For more information, see Amazon
/// ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
///
///
/// The manifest list is referencing an image that doesn't exist.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for PutImage Operation
PutImageResponse PutImage(PutImageRequest request);
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the PutImage service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutImage service method, as returned by ECRPublic.
///
/// The specified image has already been pushed, and there were no changes to the manifest
/// or image tag after the last push.
///
///
/// The specified image digest doesn't match the digest that Amazon ECR calculated for
/// the image.
///
///
/// The specified image is tagged with a tag that already exists. The repository is configured
/// for tag immutability.
///
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified layers can't be found, or the specified layer isn't valid for this repository.
///
///
/// The operation didn't succeed because it would have exceeded a service limit for your
/// account. For more information, see Amazon
/// ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
///
///
/// The manifest list is referencing an image that doesn't exist.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for PutImage Operation
Task PutImageAsync(PutImageRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutRegistryCatalogData
///
/// Create or update the catalog data for a public registry.
///
/// Container for the necessary parameters to execute the PutRegistryCatalogData service method.
///
/// The response from the PutRegistryCatalogData service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for PutRegistryCatalogData Operation
PutRegistryCatalogDataResponse PutRegistryCatalogData(PutRegistryCatalogDataRequest request);
///
/// Create or update the catalog data for a public registry.
///
/// Container for the necessary parameters to execute the PutRegistryCatalogData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutRegistryCatalogData service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for PutRegistryCatalogData Operation
Task PutRegistryCatalogDataAsync(PutRegistryCatalogDataRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutRepositoryCatalogData
///
/// Creates or updates the catalog data for a repository in a public registry.
///
/// Container for the necessary parameters to execute the PutRepositoryCatalogData service method.
///
/// The response from the PutRepositoryCatalogData service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for PutRepositoryCatalogData Operation
PutRepositoryCatalogDataResponse PutRepositoryCatalogData(PutRepositoryCatalogDataRequest request);
///
/// Creates or updates the catalog data for a repository in a public registry.
///
/// Container for the necessary parameters to execute the PutRepositoryCatalogData service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutRepositoryCatalogData service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for PutRepositoryCatalogData Operation
Task PutRepositoryCatalogDataAsync(PutRepositoryCatalogDataRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region SetRepositoryPolicy
///
/// 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.
///
/// Container for the necessary parameters to execute the SetRepositoryPolicy service method.
///
/// The response from the SetRepositoryPolicy service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for SetRepositoryPolicy Operation
SetRepositoryPolicyResponse SetRepositoryPolicy(SetRepositoryPolicyRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the SetRepositoryPolicy service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the SetRepositoryPolicy service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for SetRepositoryPolicy Operation
Task SetRepositoryPolicyAsync(SetRepositoryPolicyRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// 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.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// An invalid parameter has been specified. Tag keys can have a maximum character length
/// of 128 characters, and tag values can have a maximum length of 256 characters.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The list of tags on the repository is over the limit. The maximum number of tags that
/// can be applied to a repository is 50.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// 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.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// An invalid parameter has been specified. Tag keys can have a maximum character length
/// of 128 characters, and tag values can have a maximum length of 256 characters.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The list of tags on the repository is over the limit. The maximum number of tags that
/// can be applied to a repository is 50.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Deletes specified tags from a resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// An invalid parameter has been specified. Tag keys can have a maximum character length
/// of 128 characters, and tag values can have a maximum length of 256 characters.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The list of tags on the repository is over the limit. The maximum number of tags that
/// can be applied to a repository is 50.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Deletes specified tags from a resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by ECRPublic.
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// An invalid parameter has been specified. Tag keys can have a maximum character length
/// of 128 characters, and tag values can have a maximum length of 256 characters.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The list of tags on the repository is over the limit. The maximum number of tags that
/// can be applied to a repository is 50.
///
///
/// The action isn't supported in this Region.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UploadLayerPart
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the UploadLayerPart service method.
///
/// The response from the UploadLayerPart service method, as returned by ECRPublic.
///
/// The layer part size isn't valid, or the first byte specified isn't consecutive to
/// the last byte of a previous layer part upload.
///
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The operation didn't succeed because it would have exceeded a service limit for your
/// account. For more information, see Amazon
/// ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
///
/// The upload can't be found, or the specified upload ID isn't valid for this repository.
///
/// REST API Reference for UploadLayerPart Operation
UploadLayerPartResponse UploadLayerPart(UploadLayerPartRequest request);
///
/// 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.
///
///
///
/// Container for the necessary parameters to execute the UploadLayerPart service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UploadLayerPart service method, as returned by ECRPublic.
///
/// The layer part size isn't valid, or the first byte specified isn't consecutive to
/// the last byte of a previous layer part upload.
///
///
/// The specified parameter is invalid. Review the available parameters for the API request.
///
///
/// The operation didn't succeed because it would have exceeded a service limit for your
/// account. For more information, see Amazon
/// ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
///
///
/// The registry doesn't exist.
///
///
/// The specified repository can't be found. Check the spelling of the specified repository
/// and ensure that you're performing operations on the correct registry.
///
///
/// These errors are usually caused by a server-side issue.
///
///
/// The action isn't supported in this Region.
///
///
/// The upload can't be found, or the specified upload ID isn't valid for this repository.
///
/// REST API Reference for UploadLayerPart Operation
Task UploadLayerPartAsync(UploadLayerPartRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}