JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.ecr

Interface AmazonECR

  • All Known Subinterfaces:
    AmazonECRAsync
    All Known Implementing Classes:
    AbstractAmazonECR, AbstractAmazonECRAsync, AmazonECRAsyncClient, AmazonECRClient 

    @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonECR
    Interface for accessing Amazon ECR.

    Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonECR instead.

    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.

    Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the Amazon Web Services General Reference.

    • Method Detail

      • setEndpoint

        @Deprecated
void setEndpoint(String endpoint)
        Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
        Overrides the default endpoint for this client ("api.ecr.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

        Callers can pass in just the endpoint (ex: "api.ecr.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "api.ecr.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

        For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

        This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

        Parameters:
        endpoint - The endpoint (ex: "api.ecr.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "api.ecr.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

      • batchCheckLayerAvailability

        BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)

        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.

        Parameters:
        batchCheckLayerAvailabilityRequest -
        Returns:
        Result of the BatchCheckLayerAvailability operation returned by the service.
        Throws:
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        ServerException - These errors are usually caused by a server-side issue.
        See Also:
        AWS API Documentation

      • batchDeleteImage

        BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)

        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.

        Parameters:
        batchDeleteImageRequest - Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.
        Returns:
        Result of the BatchDeleteImage operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        See Also:
        AWS API Documentation

        Samples:
        • To delete multiple images
          This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.
          AmazonECR client = AmazonECRClientBuilder.standard().build();
BatchDeleteImageRequest request = new BatchDeleteImageRequest().withRepositoryName("ubuntu")
 .withImageIds(new ImageIdentifier().withImageTag("precise"));
BatchDeleteImageResult response = client.batchDeleteImage(request);

      • batchGetImage

        BatchGetImageResult batchGetImage(BatchGetImageRequest batchGetImageRequest)

        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.

        Parameters:
        batchGetImageRequest -
        Returns:
        Result of the BatchGetImage operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        LimitExceededException - The operation did not 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.
        UnableToGetUpstreamImageException - The image or images were unable to be pulled using the pull through cache rule. This is usually caused because of an issue with the Secrets Manager secret containing the credentials for the upstream registry.
        See Also:
        AWS API Documentation

        Samples:
        • To obtain multiple images in a single request
          This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.
          AmazonECR client = AmazonECRClientBuilder.standard().build();
BatchGetImageRequest request = new BatchGetImageRequest().withRepositoryName("ubuntu").withImageIds(new ImageIdentifier().withImageTag("precise"));
BatchGetImageResult response = client.batchGetImage(request);

      • completeLayerUpload

        CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)

        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.

        Parameters:
        completeLayerUploadRequest -
        Returns:
        Result of the CompleteLayerUpload operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        UploadNotFoundException - The upload could not be found, or the specified upload ID is not valid for this repository.
        InvalidLayerException - The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.
        LayerPartTooSmallException - Layer parts must be at least 5 MiB in size.
        LayerAlreadyExistsException - The image layer already exists in the associated repository.
        EmptyUploadException - The specified layer upload does not contain any layer parts.
        KmsException - The operation failed due to a KMS exception.
        See Also:
        AWS API Documentation

      • createRepository

        CreateRepositoryResult createRepository(CreateRepositoryRequest createRepositoryRequest)

        Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.

        Parameters:
        createRepositoryRequest -
        Returns:
        Result of the CreateRepository operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        InvalidTagParameterException - 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.
        TooManyTagsException - 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.
        RepositoryAlreadyExistsException - The specified repository already exists in the specified registry.
        LimitExceededException - The operation did not 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.
        KmsException - The operation failed due to a KMS exception.
        See Also:
        AWS API Documentation

        Samples:
        • To create a new repository
          This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.
          AmazonECR client = AmazonECRClientBuilder.standard().build();
CreateRepositoryRequest request = new CreateRepositoryRequest().withRepositoryName("project-a/nginx-web-app");
CreateRepositoryResult response = client.createRepository(request);

      • deleteRepository

        DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)

        Deletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the force option to delete the repository and have Amazon ECR delete all of its contents on your behalf.

        Parameters:
        deleteRepositoryRequest -
        Returns:
        Result of the DeleteRepository operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        RepositoryNotEmptyException - The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.
        KmsException - The operation failed due to a KMS exception.
        See Also:
        AWS API Documentation

        Samples:
        • To force delete a repository
          This example force deletes a repository named ubuntu in the default registry for an account. The force parameter is required if the repository contains images.
          AmazonECR client = AmazonECRClientBuilder.standard().build();
DeleteRepositoryRequest request = new DeleteRepositoryRequest().withRepositoryName("ubuntu").withForce(true);
DeleteRepositoryResult response = client.deleteRepository(request);

      • deleteRepositoryPolicy

        DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)

        Deletes the repository policy associated with the specified repository.

        Parameters:
        deleteRepositoryPolicyRequest -
        Returns:
        Result of the DeleteRepositoryPolicy operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        RepositoryPolicyNotFoundException - The specified repository and registry combination does not have an associated repository policy.
        See Also:
        AWS API Documentation

        Samples:
        • To delete the policy associated with a repository
          This example deletes the policy associated with the repository named ubuntu in the current account.
          AmazonECR client = AmazonECRClientBuilder.standard().build();
DeleteRepositoryPolicyRequest request = new DeleteRepositoryPolicyRequest().withRepositoryName("ubuntu");
DeleteRepositoryPolicyResult response = client.deleteRepositoryPolicy(request);

      • describeImages

        DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest)

        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.

        Parameters:
        describeImagesRequest -
        Returns:
        Result of the DescribeImages operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        ImageNotFoundException - The image requested does not exist in the specified repository.
        See Also:
        AWS API Documentation

      • describeRepositories

        DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)

        Describes image repositories in a registry.

        Parameters:
        describeRepositoriesRequest -
        Returns:
        Result of the DescribeRepositories operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        See Also:
        AWS API Documentation

        Samples:
        • To describe all repositories in the current account
          The following example obtains a list and description of all repositories in the default registry to which the current user has access.
          AmazonECR client = AmazonECRClientBuilder.standard().build();
DescribeRepositoriesRequest request = new DescribeRepositoriesRequest();
DescribeRepositoriesResult response = client.describeRepositories(request);

      • describeRepositoryCreationTemplates

        DescribeRepositoryCreationTemplatesResult describeRepositoryCreationTemplates(DescribeRepositoryCreationTemplatesRequest describeRepositoryCreationTemplatesRequest)

        Returns details about the repository creation templates in a registry. The prefixes request parameter can be used to return the details for a specific repository creation template.

        Parameters:
        describeRepositoryCreationTemplatesRequest -
        Returns:
        Result of the DescribeRepositoryCreationTemplates operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        ValidationException - There was an exception validating this request.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        See Also:
        AWS API Documentation

      • getAuthorizationToken

        GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)

        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 CLI offers an get-login-password command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.

        Parameters:
        getAuthorizationTokenRequest -
        Returns:
        Result of the GetAuthorizationToken operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        See Also:
        AWS API Documentation

        Samples:
        • To obtain an authorization token
          This example gets an authorization token for your default registry.
          AmazonECR client = AmazonECRClientBuilder.standard().build();
GetAuthorizationTokenRequest request = new GetAuthorizationTokenRequest();
GetAuthorizationTokenResult response = client.getAuthorizationToken(request);

      • getDownloadUrlForLayer

        GetDownloadUrlForLayerResult getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest)

        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.

        Parameters:
        getDownloadUrlForLayerRequest -
        Returns:
        Result of the GetDownloadUrlForLayer operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        LayersNotFoundException - The specified layers could not be found, or the specified layer is not valid for this repository.
        LayerInaccessibleException - The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        UnableToGetUpstreamLayerException - There was an issue getting the upstream layer matching the pull through cache rule.
        See Also:
        AWS API Documentation

      • getRepositoryPolicy

        GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)

        Retrieves the repository policy for the specified repository.

        Parameters:
        getRepositoryPolicyRequest -
        Returns:
        Result of the GetRepositoryPolicy operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        RepositoryPolicyNotFoundException - The specified repository and registry combination does not have an associated repository policy.
        See Also:
        AWS API Documentation

        Samples:
        • To get the current policy for a repository
          This example obtains the repository policy for the repository named ubuntu.
          AmazonECR client = AmazonECRClientBuilder.standard().build();
GetRepositoryPolicyRequest request = new GetRepositoryPolicyRequest().withRepositoryName("ubuntu");
GetRepositoryPolicyResult response = client.getRepositoryPolicy(request);

      • initiateLayerUpload

        InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)

        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.

        Parameters:
        initiateLayerUploadRequest -
        Returns:
        Result of the InitiateLayerUpload operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        KmsException - The operation failed due to a KMS exception.
        See Also:
        AWS API Documentation

      • listImages

        ListImagesResult listImages(ListImagesRequest listImagesRequest)

        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.

        Parameters:
        listImagesRequest -
        Returns:
        Result of the ListImages operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        See Also:
        AWS API Documentation

        Samples:
        • To list all images in a repository
          This example lists all of the images in the repository named ubuntu in the default registry in the current account.
          AmazonECR client = AmazonECRClientBuilder.standard().build();
ListImagesRequest request = new ListImagesRequest().withRepositoryName("ubuntu");
ListImagesResult response = client.listImages(request);

      • listTagsForResource

        ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

        List the tags for an Amazon ECR resource.

        Parameters:
        listTagsForResourceRequest -
        Returns:
        Result of the ListTagsForResource operation returned by the service.
        Throws:
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        ServerException - These errors are usually caused by a server-side issue.
        See Also:
        AWS API Documentation

      • putImage

        PutImageResult putImage(PutImageRequest putImageRequest)

        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.

        Parameters:
        putImageRequest -
        Returns:
        Result of the PutImage operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        ImageAlreadyExistsException - The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.
        LayersNotFoundException - The specified layers could not be found, or the specified layer is not valid for this repository.
        ReferencedImagesNotFoundException - The manifest list is referencing an image that does not exist.
        LimitExceededException - The operation did not 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.
        ImageTagAlreadyExistsException - The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.
        ImageDigestDoesNotMatchException - The specified image digest does not match the digest that Amazon ECR calculated for the image.
        KmsException - The operation failed due to a KMS exception.
        See Also:
        AWS API Documentation

      • putImageScanningConfiguration

        PutImageScanningConfigurationResult putImageScanningConfiguration(PutImageScanningConfigurationRequest putImageScanningConfigurationRequest)

        The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.

        Updates the image scanning configuration for the specified repository.

        Parameters:
        putImageScanningConfigurationRequest -
        Returns:
        Result of the PutImageScanningConfiguration operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        ValidationException - There was an exception validating this request.
        See Also:
        AWS API Documentation

      • putImageTagMutability

        PutImageTagMutabilityResult putImageTagMutability(PutImageTagMutabilityRequest putImageTagMutabilityRequest)

        Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.

        Parameters:
        putImageTagMutabilityRequest -
        Returns:
        Result of the PutImageTagMutability operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        See Also:
        AWS API Documentation

      • putRegistryPolicy

        PutRegistryPolicyResult putRegistryPolicy(PutRegistryPolicyRequest putRegistryPolicyRequest)

        Creates or updates the permissions policy for your registry.

        A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.

        Parameters:
        putRegistryPolicyRequest -
        Returns:
        Result of the PutRegistryPolicy operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        ValidationException - There was an exception validating this request.
        See Also:
        AWS API Documentation

      • putReplicationConfiguration

        PutReplicationConfigurationResult putReplicationConfiguration(PutReplicationConfigurationRequest putReplicationConfigurationRequest)

        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 in the Amazon Elastic Container Registry User Guide. For more information on the custom role for replication, see Creating an IAM role for replication.

        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.

        Parameters:
        putReplicationConfigurationRequest -
        Returns:
        Result of the PutReplicationConfiguration operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        ValidationException - There was an exception validating this request.
        See Also:
        AWS API Documentation

      • setRepositoryPolicy

        SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)

        Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon Elastic Container Registry User Guide.

        Parameters:
        setRepositoryPolicyRequest -
        Returns:
        Result of the SetRepositoryPolicy operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        See Also:
        AWS API Documentation

      • startImageScan

        StartImageScanResult startImageScan(StartImageScanRequest startImageScanRequest)

        Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.

        Parameters:
        startImageScanRequest -
        Returns:
        Result of the StartImageScan operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        UnsupportedImageTypeException - The image is of a type that cannot be scanned.
        LimitExceededException - The operation did not 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.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        ImageNotFoundException - The image requested does not exist in the specified repository.
        ValidationException - There was an exception validating this request.
        See Also:
        AWS API Documentation

      • tagResource

        TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

        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.

        Parameters:
        tagResourceRequest -
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        InvalidTagParameterException - 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.
        TooManyTagsException - 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.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        ServerException - These errors are usually caused by a server-side issue.
        See Also:
        AWS API Documentation

      • untagResource

        UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

        Deletes specified tags from a resource.

        Parameters:
        untagResourceRequest -
        Returns:
        Result of the UntagResource operation returned by the service.
        Throws:
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        InvalidTagParameterException - 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.
        TooManyTagsException - 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.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        ServerException - These errors are usually caused by a server-side issue.
        See Also:
        AWS API Documentation

      • uploadLayerPart

        UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)

        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.

        Parameters:
        uploadLayerPartRequest -
        Returns:
        Result of the UploadLayerPart operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        InvalidLayerPartException - The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.
        RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
        UploadNotFoundException - The upload could not be found, or the specified upload ID is not valid for this repository.
        LimitExceededException - The operation did not 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.
        KmsException - The operation failed due to a KMS exception.
        See Also:
        AWS API Documentation

      • validatePullThroughCacheRule

        ValidatePullThroughCacheRuleResult validatePullThroughCacheRule(ValidatePullThroughCacheRuleRequest validatePullThroughCacheRuleRequest)

        Validates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.

        Parameters:
        validatePullThroughCacheRuleRequest -
        Returns:
        Result of the ValidatePullThroughCacheRule operation returned by the service.
        Throws:
        ServerException - These errors are usually caused by a server-side issue.
        InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.
        ValidationException - There was an exception validating this request.
        PullThroughCacheRuleNotFoundException - The pull through cache rule was not found. Specify a valid pull through cache rule and try again.
        See Also:
        AWS API Documentation

      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /