Interface EcrClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EcrClient extends AwsClient
Service client for accessing Amazon ECR. This can be created using the staticbuilder()method.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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchCheckLayerAvailability
default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchCheckLayerAvailability
default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
BatchCheckLayerAvailabilityRequest.Builderavoiding the need to create one manually viaBatchCheckLayerAvailabilityRequest.builder()- Parameters:
batchCheckLayerAvailabilityRequest- AConsumerthat will call methods onBatchCheckLayerAvailabilityRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteImage
default BatchDeleteImageResponse batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a list of specified images within a repository. Images are specified with either an
imageTagorimageDigest.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 theimageTagorimageDigest.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteImage
default BatchDeleteImageResponse batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a list of specified images within a repository. Images are specified with either an
imageTagorimageDigest.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.
This is a convenience which creates an instance of the
BatchDeleteImageRequest.Builderavoiding the need to create one manually viaBatchDeleteImageRequest.builder()- Parameters:
batchDeleteImageRequest- AConsumerthat will call methods onBatchDeleteImageRequest.Builderto create a request. Deletes specified images within a specified repository. Images are specified with either theimageTagorimageDigest.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetImage
default BatchGetImageResponse batchGetImage(BatchGetImageRequest batchGetImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LimitExceededException, UnableToGetUpstreamImageException, AwsServiceException, SdkClientException, EcrException
Gets detailed information for an image. Images are specified with either an
imageTagorimageDigest.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetImage
default BatchGetImageResponse batchGetImage(Consumer<BatchGetImageRequest.Builder> batchGetImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LimitExceededException, UnableToGetUpstreamImageException, AwsServiceException, SdkClientException, EcrException
Gets detailed information for an image. Images are specified with either an
imageTagorimageDigest.When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
This is a convenience which creates an instance of the
BatchGetImageRequest.Builderavoiding the need to create one manually viaBatchGetImageRequest.builder()- Parameters:
batchGetImageRequest- AConsumerthat will call methods onBatchGetImageRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetRepositoryScanningConfiguration
default BatchGetRepositoryScanningConfigurationResponse batchGetRepositoryScanningConfiguration(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Gets the scanning configuration for one or more repositories.
- Parameters:
batchGetRepositoryScanningConfigurationRequest-- Returns:
- Result of the BatchGetRepositoryScanningConfiguration 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetRepositoryScanningConfiguration
default BatchGetRepositoryScanningConfigurationResponse batchGetRepositoryScanningConfiguration(Consumer<BatchGetRepositoryScanningConfigurationRequest.Builder> batchGetRepositoryScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Gets the scanning configuration for one or more repositories.
This is a convenience which creates an instance of the
BatchGetRepositoryScanningConfigurationRequest.Builderavoiding the need to create one manually viaBatchGetRepositoryScanningConfigurationRequest.builder()- Parameters:
batchGetRepositoryScanningConfigurationRequest- AConsumerthat will call methods onBatchGetRepositoryScanningConfigurationRequest.Builderto create a request.- Returns:
- Result of the BatchGetRepositoryScanningConfiguration 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
completeLayerUpload
default CompleteLayerUploadResponse completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, KmsException, AwsServiceException, SdkClientException, EcrException
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a
sha256digest 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
dockerCLI 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
completeLayerUpload
default CompleteLayerUploadResponse completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, KmsException, AwsServiceException, SdkClientException, EcrException
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a
sha256digest 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
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
CompleteLayerUploadRequest.Builderavoiding the need to create one manually viaCompleteLayerUploadRequest.builder()- Parameters:
completeLayerUploadRequest- AConsumerthat will call methods onCompleteLayerUploadRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPullThroughCacheRule
default CreatePullThroughCacheRuleResponse createPullThroughCacheRule(CreatePullThroughCacheRuleRequest createPullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleAlreadyExistsException, UnsupportedUpstreamRegistryException, LimitExceededException, UnableToAccessSecretException, SecretNotFoundException, UnableToDecryptSecretValueException, AwsServiceException, SdkClientException, EcrException
Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.
- Parameters:
createPullThroughCacheRuleRequest-- Returns:
- Result of the CreatePullThroughCacheRule 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.PullThroughCacheRuleAlreadyExistsException- A pull through cache rule with these settings already exists for the private registry.UnsupportedUpstreamRegistryException- The specified upstream registry isn't supported.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.UnableToAccessSecretException- The secret is unable to be accessed. Verify the resource permissions for the secret and try again.SecretNotFoundException- The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.UnableToDecryptSecretValueException- The secret is accessible but is unable to be decrypted. Verify the resource permisisons and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createPullThroughCacheRule
default CreatePullThroughCacheRuleResponse createPullThroughCacheRule(Consumer<CreatePullThroughCacheRuleRequest.Builder> createPullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleAlreadyExistsException, UnsupportedUpstreamRegistryException, LimitExceededException, UnableToAccessSecretException, SecretNotFoundException, UnableToDecryptSecretValueException, AwsServiceException, SdkClientException, EcrException
Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
CreatePullThroughCacheRuleRequest.Builderavoiding the need to create one manually viaCreatePullThroughCacheRuleRequest.builder()- Parameters:
createPullThroughCacheRuleRequest- AConsumerthat will call methods onCreatePullThroughCacheRuleRequest.Builderto create a request.- Returns:
- Result of the CreatePullThroughCacheRule 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.PullThroughCacheRuleAlreadyExistsException- A pull through cache rule with these settings already exists for the private registry.UnsupportedUpstreamRegistryException- The specified upstream registry isn't supported.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.UnableToAccessSecretException- The secret is unable to be accessed. Verify the resource permissions for the secret and try again.SecretNotFoundException- The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.UnableToDecryptSecretValueException- The secret is accessible but is unable to be decrypted. Verify the resource permisisons and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRepository
default CreateRepositoryResponse createRepository(CreateRepositoryRequest createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRepository
default CreateRepositoryResponse createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException
Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
CreateRepositoryRequest.Builderavoiding the need to create one manually viaCreateRepositoryRequest.builder()- Parameters:
createRepositoryRequest- AConsumerthat will call methods onCreateRepositoryRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRepositoryCreationTemplate
default CreateRepositoryCreationTemplateResponse createRepositoryCreationTemplate(CreateRepositoryCreationTemplateRequest createRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, LimitExceededException, TemplateAlreadyExistsException, AwsServiceException, SdkClientException, EcrException
Creates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see Private repository creation templates in the Amazon Elastic Container Registry User Guide.
- Parameters:
createRepositoryCreationTemplateRequest-- Returns:
- Result of the CreateRepositoryCreationTemplate 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.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.TemplateAlreadyExistsException- The repository creation template already exists. Specify a unique prefix and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRepositoryCreationTemplate
default CreateRepositoryCreationTemplateResponse createRepositoryCreationTemplate(Consumer<CreateRepositoryCreationTemplateRequest.Builder> createRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, LimitExceededException, TemplateAlreadyExistsException, AwsServiceException, SdkClientException, EcrException
Creates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see Private repository creation templates in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
CreateRepositoryCreationTemplateRequest.Builderavoiding the need to create one manually viaCreateRepositoryCreationTemplateRequest.builder()- Parameters:
createRepositoryCreationTemplateRequest- AConsumerthat will call methods onCreateRepositoryCreationTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateRepositoryCreationTemplate 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.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.TemplateAlreadyExistsException- The repository creation template already exists. Specify a unique prefix and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLifecyclePolicy
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Deletes the lifecycle policy associated with the specified repository.
- Parameters:
deleteLifecyclePolicyRequest-- Returns:
- Result of the DeleteLifecyclePolicy 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.LifecyclePolicyNotFoundException- The lifecycle policy could not be found, and no policy is set to the repository.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLifecyclePolicy
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Deletes the lifecycle policy associated with the specified repository.
This is a convenience which creates an instance of the
DeleteLifecyclePolicyRequest.Builderavoiding the need to create one manually viaDeleteLifecyclePolicyRequest.builder()- Parameters:
deleteLifecyclePolicyRequest- AConsumerthat will call methods onDeleteLifecyclePolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteLifecyclePolicy 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.LifecyclePolicyNotFoundException- The lifecycle policy could not be found, and no policy is set to the repository.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePullThroughCacheRule
default DeletePullThroughCacheRuleResponse deletePullThroughCacheRule(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a pull through cache rule.
- Parameters:
deletePullThroughCacheRuleRequest-- Returns:
- Result of the DeletePullThroughCacheRule 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePullThroughCacheRule
default DeletePullThroughCacheRuleResponse deletePullThroughCacheRule(Consumer<DeletePullThroughCacheRuleRequest.Builder> deletePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a pull through cache rule.
This is a convenience which creates an instance of the
DeletePullThroughCacheRuleRequest.Builderavoiding the need to create one manually viaDeletePullThroughCacheRuleRequest.builder()- Parameters:
deletePullThroughCacheRuleRequest- AConsumerthat will call methods onDeletePullThroughCacheRuleRequest.Builderto create a request.- Returns:
- Result of the DeletePullThroughCacheRule 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRegistryPolicy
default DeleteRegistryPolicyResponse deleteRegistryPolicy(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Deletes the registry permissions policy.
- Parameters:
deleteRegistryPolicyRequest-- Returns:
- Result of the DeleteRegistryPolicy 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.RegistryPolicyNotFoundException- The registry doesn't have an associated registry policy.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRegistryPolicy
default DeleteRegistryPolicyResponse deleteRegistryPolicy(Consumer<DeleteRegistryPolicyRequest.Builder> deleteRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Deletes the registry permissions policy.
This is a convenience which creates an instance of the
DeleteRegistryPolicyRequest.Builderavoiding the need to create one manually viaDeleteRegistryPolicyRequest.builder()- Parameters:
deleteRegistryPolicyRequest- AConsumerthat will call methods onDeleteRegistryPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteRegistryPolicy 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.RegistryPolicyNotFoundException- The registry doesn't have an associated registry policy.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, KmsException, AwsServiceException, SdkClientException, EcrException
Deletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the
forceoption 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 theforceparameter.KmsException- The operation failed due to a KMS exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, KmsException, AwsServiceException, SdkClientException, EcrException
Deletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the
forceoption to delete the repository and have Amazon ECR delete all of its contents on your behalf.
This is a convenience which creates an instance of the
DeleteRepositoryRequest.Builderavoiding the need to create one manually viaDeleteRepositoryRequest.builder()- Parameters:
deleteRepositoryRequest- AConsumerthat will call methods onDeleteRepositoryRequest.Builderto create a request.- 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 theforceparameter.KmsException- The operation failed due to a KMS exception.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepositoryCreationTemplate
default DeleteRepositoryCreationTemplateResponse deleteRepositoryCreationTemplate(DeleteRepositoryCreationTemplateRequest deleteRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, TemplateNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a repository creation template.
- Parameters:
deleteRepositoryCreationTemplateRequest-- Returns:
- Result of the DeleteRepositoryCreationTemplate 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.TemplateNotFoundException- The specified repository creation template can't be found. Verify the registry ID and prefix and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepositoryCreationTemplate
default DeleteRepositoryCreationTemplateResponse deleteRepositoryCreationTemplate(Consumer<DeleteRepositoryCreationTemplateRequest.Builder> deleteRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, TemplateNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a repository creation template.
This is a convenience which creates an instance of the
DeleteRepositoryCreationTemplateRequest.Builderavoiding the need to create one manually viaDeleteRepositoryCreationTemplateRequest.builder()- Parameters:
deleteRepositoryCreationTemplateRequest- AConsumerthat will call methods onDeleteRepositoryCreationTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteRepositoryCreationTemplate 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.TemplateNotFoundException- The specified repository creation template can't be found. Verify the registry ID and prefix and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepositoryPolicy
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepositoryPolicy
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes the repository policy associated with the specified repository.
This is a convenience which creates an instance of the
DeleteRepositoryPolicyRequest.Builderavoiding the need to create one manually viaDeleteRepositoryPolicyRequest.builder()- Parameters:
deleteRepositoryPolicyRequest- AConsumerthat will call methods onDeleteRepositoryPolicyRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageReplicationStatus
default DescribeImageReplicationStatusResponse describeImageReplicationStatus(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest) throws ServerException, InvalidParameterException, ImageNotFoundException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the replication status for a specified image.
- Parameters:
describeImageReplicationStatusRequest-- Returns:
- Result of the DescribeImageReplicationStatus 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.ImageNotFoundException- The image requested does not exist in the specified repository.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageReplicationStatus
default DescribeImageReplicationStatusResponse describeImageReplicationStatus(Consumer<DescribeImageReplicationStatusRequest.Builder> describeImageReplicationStatusRequest) throws ServerException, InvalidParameterException, ImageNotFoundException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the replication status for a specified image.
This is a convenience which creates an instance of the
DescribeImageReplicationStatusRequest.Builderavoiding the need to create one manually viaDescribeImageReplicationStatusRequest.builder()- Parameters:
describeImageReplicationStatusRequest- AConsumerthat will call methods onDescribeImageReplicationStatusRequest.Builderto create a request.- Returns:
- Result of the DescribeImageReplicationStatus 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.ImageNotFoundException- The image requested does not exist in the specified repository.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageScanFindings
default DescribeImageScanFindingsResponse describeImageScanFindings(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the scan findings for the specified image.
- Parameters:
describeImageScanFindingsRequest-- Returns:
- Result of the DescribeImageScanFindings 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.ScanNotFoundException- The specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageScanFindings
default DescribeImageScanFindingsResponse describeImageScanFindings(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the scan findings for the specified image.
This is a convenience which creates an instance of the
DescribeImageScanFindingsRequest.Builderavoiding the need to create one manually viaDescribeImageScanFindingsRequest.builder()- Parameters:
describeImageScanFindingsRequest- AConsumerthat will call methods onDescribeImageScanFindingsRequest.Builderto create a request.- Returns:
- Result of the DescribeImageScanFindings 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.ScanNotFoundException- The specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageScanFindingsPaginator
default DescribeImageScanFindingsIterable describeImageScanFindingsPaginator(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client .describeImageScanFindingsPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)operation.- Parameters:
describeImageScanFindingsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.ScanNotFoundException- The specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageScanFindingsPaginator
default DescribeImageScanFindingsIterable describeImageScanFindingsPaginator(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client .describeImageScanFindingsPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)operation.
This is a convenience which creates an instance of the
DescribeImageScanFindingsRequest.Builderavoiding the need to create one manually viaDescribeImageScanFindingsRequest.builder()- Parameters:
describeImageScanFindingsRequest- AConsumerthat will call methods onDescribeImageScanFindingsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.ScanNotFoundException- The specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImages
default DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
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 imagescommand 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImages
default DescribeImagesResponse describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
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 imagescommand shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builderavoiding the need to create one manually viaDescribeImagesRequest.builder()- Parameters:
describeImagesRequest- AConsumerthat will call methods onDescribeImagesRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImagesPaginator
default DescribeImagesIterable describeImagesPaginator(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)operation.- Parameters:
describeImagesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeImagesPaginator
default DescribeImagesIterable describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)operation.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builderavoiding the need to create one manually viaDescribeImagesRequest.builder()- Parameters:
describeImagesRequest- AConsumerthat will call methods onDescribeImagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePullThroughCacheRules
default DescribePullThroughCacheRulesResponse describePullThroughCacheRules(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns the pull through cache rules for a registry.
- Parameters:
describePullThroughCacheRulesRequest-- Returns:
- Result of the DescribePullThroughCacheRules 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePullThroughCacheRules
default DescribePullThroughCacheRulesResponse describePullThroughCacheRules(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns the pull through cache rules for a registry.
This is a convenience which creates an instance of the
DescribePullThroughCacheRulesRequest.Builderavoiding the need to create one manually viaDescribePullThroughCacheRulesRequest.builder()- Parameters:
describePullThroughCacheRulesRequest- AConsumerthat will call methods onDescribePullThroughCacheRulesRequest.Builderto create a request.- Returns:
- Result of the DescribePullThroughCacheRules 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePullThroughCacheRulesPaginator
default DescribePullThroughCacheRulesIterable describePullThroughCacheRulesPaginator(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client .describePullThroughCacheRulesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)operation.- Parameters:
describePullThroughCacheRulesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePullThroughCacheRulesPaginator
default DescribePullThroughCacheRulesIterable describePullThroughCacheRulesPaginator(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client .describePullThroughCacheRulesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)operation.
This is a convenience which creates an instance of the
DescribePullThroughCacheRulesRequest.Builderavoiding the need to create one manually viaDescribePullThroughCacheRulesRequest.builder()- Parameters:
describePullThroughCacheRulesRequest- AConsumerthat will call methods onDescribePullThroughCacheRulesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRegistry
default DescribeRegistryResponse describeRegistry(DescribeRegistryRequest describeRegistryRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
- Parameters:
describeRegistryRequest-- Returns:
- Result of the DescribeRegistry 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRegistry
default DescribeRegistryResponse describeRegistry(Consumer<DescribeRegistryRequest.Builder> describeRegistryRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
This is a convenience which creates an instance of the
DescribeRegistryRequest.Builderavoiding the need to create one manually viaDescribeRegistryRequest.builder()- Parameters:
describeRegistryRequest- AConsumerthat will call methods onDescribeRegistryRequest.Builderto create a request.- Returns:
- Result of the DescribeRegistry 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
This is a convenience which creates an instance of the
DescribeRepositoriesRequest.Builderavoiding the need to create one manually viaDescribeRepositoriesRequest.builder()- Parameters:
describeRepositoriesRequest- AConsumerthat will call methods onDescribeRepositoriesRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories() throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeRepositories(DescribeRepositoriesRequest), AWS API Documentation
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator() throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeRepositoriesPaginator(DescribeRepositoriesRequest), AWS API Documentation
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)operation.- Parameters:
describeRepositoriesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)operation.
This is a convenience which creates an instance of the
DescribeRepositoriesRequest.Builderavoiding the need to create one manually viaDescribeRepositoriesRequest.builder()- Parameters:
describeRepositoriesRequest- AConsumerthat will call methods onDescribeRepositoriesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositoryCreationTemplates
default DescribeRepositoryCreationTemplatesResponse describeRepositoryCreationTemplates(DescribeRepositoryCreationTemplatesRequest describeRepositoryCreationTemplatesRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
Returns details about the repository creation templates in a registry. The
prefixesrequest 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositoryCreationTemplates
default DescribeRepositoryCreationTemplatesResponse describeRepositoryCreationTemplates(Consumer<DescribeRepositoryCreationTemplatesRequest.Builder> describeRepositoryCreationTemplatesRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
Returns details about the repository creation templates in a registry. The
prefixesrequest parameter can be used to return the details for a specific repository creation template.
This is a convenience which creates an instance of the
DescribeRepositoryCreationTemplatesRequest.Builderavoiding the need to create one manually viaDescribeRepositoryCreationTemplatesRequest.builder()- Parameters:
describeRepositoryCreationTemplatesRequest- AConsumerthat will call methods onDescribeRepositoryCreationTemplatesRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositoryCreationTemplatesPaginator
default DescribeRepositoryCreationTemplatesIterable describeRepositoryCreationTemplatesPaginator(DescribeRepositoryCreationTemplatesRequest describeRepositoryCreationTemplatesRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client.describeRepositoryCreationTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client .describeRepositoryCreationTemplatesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client.describeRepositoryCreationTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)operation.- Parameters:
describeRepositoryCreationTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositoryCreationTemplatesPaginator
default DescribeRepositoryCreationTemplatesIterable describeRepositoryCreationTemplatesPaginator(Consumer<DescribeRepositoryCreationTemplatesRequest.Builder> describeRepositoryCreationTemplatesRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
This is a variant of
describeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client.describeRepositoryCreationTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client .describeRepositoryCreationTemplatesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client.describeRepositoryCreationTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)operation.
This is a convenience which creates an instance of the
DescribeRepositoryCreationTemplatesRequest.Builderavoiding the need to create one manually viaDescribeRepositoryCreationTemplatesRequest.builder()- Parameters:
describeRepositoryCreationTemplatesRequest- AConsumerthat will call methods onDescribeRepositoryCreationTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAccountSetting
default GetAccountSettingResponse getAccountSetting(GetAccountSettingRequest getAccountSettingRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
Retrieves the basic scan type version name.
- Parameters:
getAccountSettingRequest-- Returns:
- Result of the GetAccountSetting 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAccountSetting
default GetAccountSettingResponse getAccountSetting(Consumer<GetAccountSettingRequest.Builder> getAccountSettingRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
Retrieves the basic scan type version name.
This is a convenience which creates an instance of the
GetAccountSettingRequest.Builderavoiding the need to create one manually viaGetAccountSettingRequest.builder()- Parameters:
getAccountSettingRequest- AConsumerthat will call methods onGetAccountSettingRequest.Builderto create a request.- Returns:
- Result of the GetAccountSetting 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
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
authorizationTokenreturned is a base64 encoded string that can be decoded and used in adocker logincommand to authenticate to a registry. The CLI offers anget-login-passwordcommand 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
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
authorizationTokenreturned is a base64 encoded string that can be decoded and used in adocker logincommand to authenticate to a registry. The CLI offers anget-login-passwordcommand that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
GetAuthorizationTokenRequest.Builderavoiding the need to create one manually viaGetAuthorizationTokenRequest.builder()- Parameters:
getAuthorizationTokenRequest- AConsumerthat will call methods onGetAuthorizationTokenRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken() throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
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
authorizationTokenreturned is a base64 encoded string that can be decoded and used in adocker logincommand to authenticate to a registry. The CLI offers anget-login-passwordcommand that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
getAuthorizationToken(GetAuthorizationTokenRequest), AWS API Documentation
-
getDownloadUrlForLayer
default GetDownloadUrlForLayerResponse getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) throws ServerException, InvalidParameterException, LayersNotFoundException, LayerInaccessibleException, RepositoryNotFoundException, UnableToGetUpstreamLayerException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getDownloadUrlForLayer
default GetDownloadUrlForLayerResponse getDownloadUrlForLayer(Consumer<GetDownloadUrlForLayerRequest.Builder> getDownloadUrlForLayerRequest) throws ServerException, InvalidParameterException, LayersNotFoundException, LayerInaccessibleException, RepositoryNotFoundException, UnableToGetUpstreamLayerException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
GetDownloadUrlForLayerRequest.Builderavoiding the need to create one manually viaGetDownloadUrlForLayerRequest.builder()- Parameters:
getDownloadUrlForLayerRequest- AConsumerthat will call methods onGetDownloadUrlForLayerRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecyclePolicy
default GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the lifecycle policy for the specified repository.
- Parameters:
getLifecyclePolicyRequest-- Returns:
- Result of the GetLifecyclePolicy 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.LifecyclePolicyNotFoundException- The lifecycle policy could not be found, and no policy is set to the repository.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecyclePolicy
default GetLifecyclePolicyResponse getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the lifecycle policy for the specified repository.
This is a convenience which creates an instance of the
GetLifecyclePolicyRequest.Builderavoiding the need to create one manually viaGetLifecyclePolicyRequest.builder()- Parameters:
getLifecyclePolicyRequest- AConsumerthat will call methods onGetLifecyclePolicyRequest.Builderto create a request.- Returns:
- Result of the GetLifecyclePolicy 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.LifecyclePolicyNotFoundException- The lifecycle policy could not be found, and no policy is set to the repository.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecyclePolicyPreview
default GetLifecyclePolicyPreviewResponse getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the results of the lifecycle policy preview request for the specified repository.
- Parameters:
getLifecyclePolicyPreviewRequest-- Returns:
- Result of the GetLifecyclePolicyPreview 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.LifecyclePolicyPreviewNotFoundException- There is no dry run for this repository.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecyclePolicyPreview
default GetLifecyclePolicyPreviewResponse getLifecyclePolicyPreview(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the results of the lifecycle policy preview request for the specified repository.
This is a convenience which creates an instance of the
GetLifecyclePolicyPreviewRequest.Builderavoiding the need to create one manually viaGetLifecyclePolicyPreviewRequest.builder()- Parameters:
getLifecyclePolicyPreviewRequest- AConsumerthat will call methods onGetLifecyclePolicyPreviewRequest.Builderto create a request.- Returns:
- Result of the GetLifecyclePolicyPreview 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.LifecyclePolicyPreviewNotFoundException- There is no dry run for this repository.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecyclePolicyPreviewPaginator
default GetLifecyclePolicyPreviewIterable getLifecyclePolicyPreviewPaginator(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client .getLifecyclePolicyPreviewPaginator(request); for (software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)operation.- Parameters:
getLifecyclePolicyPreviewRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.LifecyclePolicyPreviewNotFoundException- There is no dry run for this repository.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getLifecyclePolicyPreviewPaginator
default GetLifecyclePolicyPreviewIterable getLifecyclePolicyPreviewPaginator(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client .getLifecyclePolicyPreviewPaginator(request); for (software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)operation.
This is a convenience which creates an instance of the
GetLifecyclePolicyPreviewRequest.Builderavoiding the need to create one manually viaGetLifecyclePolicyPreviewRequest.builder()- Parameters:
getLifecyclePolicyPreviewRequest- AConsumerthat will call methods onGetLifecyclePolicyPreviewRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.LifecyclePolicyPreviewNotFoundException- There is no dry run for this repository.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRegistryPolicy
default GetRegistryPolicyResponse getRegistryPolicy(GetRegistryPolicyRequest getRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the permissions policy for a registry.
- Parameters:
getRegistryPolicyRequest-- Returns:
- Result of the GetRegistryPolicy 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.RegistryPolicyNotFoundException- The registry doesn't have an associated registry policy.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRegistryPolicy
default GetRegistryPolicyResponse getRegistryPolicy(Consumer<GetRegistryPolicyRequest.Builder> getRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the permissions policy for a registry.
This is a convenience which creates an instance of the
GetRegistryPolicyRequest.Builderavoiding the need to create one manually viaGetRegistryPolicyRequest.builder()- Parameters:
getRegistryPolicyRequest- AConsumerthat will call methods onGetRegistryPolicyRequest.Builderto create a request.- Returns:
- Result of the GetRegistryPolicy 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.RegistryPolicyNotFoundException- The registry doesn't have an associated registry policy.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRegistryScanningConfiguration
default GetRegistryScanningConfigurationResponse getRegistryScanningConfiguration(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the scanning configuration for a registry.
- Parameters:
getRegistryScanningConfigurationRequest-- Returns:
- Result of the GetRegistryScanningConfiguration 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRegistryScanningConfiguration
default GetRegistryScanningConfigurationResponse getRegistryScanningConfiguration(Consumer<GetRegistryScanningConfigurationRequest.Builder> getRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the scanning configuration for a registry.
This is a convenience which creates an instance of the
GetRegistryScanningConfigurationRequest.Builderavoiding the need to create one manually viaGetRegistryScanningConfigurationRequest.builder()- Parameters:
getRegistryScanningConfigurationRequest- AConsumerthat will call methods onGetRegistryScanningConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetRegistryScanningConfiguration 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRepositoryPolicy
default GetRepositoryPolicyResponse getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRepositoryPolicy
default GetRepositoryPolicyResponse getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the repository policy for the specified repository.
This is a convenience which creates an instance of the
GetRepositoryPolicyRequest.Builderavoiding the need to create one manually viaGetRepositoryPolicyRequest.builder()- Parameters:
getRepositoryPolicyRequest- AConsumerthat will call methods onGetRepositoryPolicyRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
initiateLayerUpload
default InitiateLayerUploadResponse initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, KmsException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
initiateLayerUpload
default InitiateLayerUploadResponse initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, KmsException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
InitiateLayerUploadRequest.Builderavoiding the need to create one manually viaInitiateLayerUploadRequest.builder()- Parameters:
initiateLayerUploadRequest- AConsumerthat will call methods onInitiateLayerUploadRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImages
default ListImagesResponse listImages(ListImagesRequest listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the
tagStatusfilter and specifying eitherTAGGED,UNTAGGEDorANY. For example, you can filter your results to return onlyUNTAGGEDimages and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return onlyTAGGEDimages 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImages
default ListImagesResponse listImages(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the
tagStatusfilter and specifying eitherTAGGED,UNTAGGEDorANY. For example, you can filter your results to return onlyUNTAGGEDimages and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return onlyTAGGEDimages to list all of the tags in your repository.
This is a convenience which creates an instance of the
ListImagesRequest.Builderavoiding the need to create one manually viaListImagesRequest.builder()- Parameters:
listImagesRequest- AConsumerthat will call methods onListImagesRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImagesPaginator
default ListImagesIterable listImagesPaginator(ListImagesRequest listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
This is a variant of
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.ListImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)operation.- Parameters:
listImagesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImagesPaginator
default ListImagesIterable listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
This is a variant of
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.ListImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)operation.
This is a convenience which creates an instance of the
ListImagesRequest.Builderavoiding the need to create one manually viaListImagesRequest.builder()- Parameters:
listImagesRequest- AConsumerthat will call methods onListImagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
List the tags for an Amazon ECR resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putAccountSetting
default PutAccountSettingResponse putAccountSetting(PutAccountSettingRequest putAccountSettingRequest) throws ServerException, ValidationException, InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
Allows you to change the basic scan type version by setting the
nameparameter to eitherCLAIRtoAWS_NATIVE.- Parameters:
putAccountSettingRequest-- Returns:
- Result of the PutAccountSetting 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.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putAccountSetting
default PutAccountSettingResponse putAccountSetting(Consumer<PutAccountSettingRequest.Builder> putAccountSettingRequest) throws ServerException, ValidationException, InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
Allows you to change the basic scan type version by setting the
nameparameter to eitherCLAIRtoAWS_NATIVE.
This is a convenience which creates an instance of the
PutAccountSettingRequest.Builderavoiding the need to create one manually viaPutAccountSettingRequest.builder()- Parameters:
putAccountSettingRequest- AConsumerthat will call methods onPutAccountSettingRequest.Builderto create a request.- Returns:
- Result of the PutAccountSetting 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.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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putImage
default PutImageResponse putImage(PutImageRequest putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, KmsException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putImage
default PutImageResponse putImage(Consumer<PutImageRequest.Builder> putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, KmsException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
PutImageRequest.Builderavoiding the need to create one manually viaPutImageRequest.builder()- Parameters:
putImageRequest- AConsumerthat will call methods onPutImageRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putImageScanningConfiguration
default PutImageScanningConfigurationResponse putImageScanningConfiguration(PutImageScanningConfigurationRequest putImageScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
The
PutImageScanningConfigurationAPI 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putImageScanningConfiguration
default PutImageScanningConfigurationResponse putImageScanningConfiguration(Consumer<PutImageScanningConfigurationRequest.Builder> putImageScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
The
PutImageScanningConfigurationAPI 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.
This is a convenience which creates an instance of the
PutImageScanningConfigurationRequest.Builderavoiding the need to create one manually viaPutImageScanningConfigurationRequest.builder()- Parameters:
putImageScanningConfigurationRequest- AConsumerthat will call methods onPutImageScanningConfigurationRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putImageTagMutability
default PutImageTagMutabilityResponse putImageTagMutability(PutImageTagMutabilityRequest putImageTagMutabilityRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putImageTagMutability
default PutImageTagMutabilityResponse putImageTagMutability(Consumer<PutImageTagMutabilityRequest.Builder> putImageTagMutabilityRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the
PutImageTagMutabilityRequest.Builderavoiding the need to create one manually viaPutImageTagMutabilityRequest.builder()- Parameters:
putImageTagMutabilityRequest- AConsumerthat will call methods onPutImageTagMutabilityRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putLifecyclePolicy
default PutLifecyclePolicyResponse putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
- Parameters:
putLifecyclePolicyRequest-- Returns:
- Result of the PutLifecyclePolicy 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putLifecyclePolicy
default PutLifecyclePolicyResponse putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
This is a convenience which creates an instance of the
PutLifecyclePolicyRequest.Builderavoiding the need to create one manually viaPutLifecyclePolicyRequest.builder()- Parameters:
putLifecyclePolicyRequest- AConsumerthat will call methods onPutLifecyclePolicyRequest.Builderto create a request.- Returns:
- Result of the PutLifecyclePolicy 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putRegistryPolicy
default PutRegistryPolicyResponse putRegistryPolicy(PutRegistryPolicyRequest putRegistryPolicyRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putRegistryPolicy
default PutRegistryPolicyResponse putRegistryPolicy(Consumer<PutRegistryPolicyRequest.Builder> putRegistryPolicyRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the
PutRegistryPolicyRequest.Builderavoiding the need to create one manually viaPutRegistryPolicyRequest.builder()- Parameters:
putRegistryPolicyRequest- AConsumerthat will call methods onPutRegistryPolicyRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putRegistryScanningConfiguration
default PutRegistryScanningConfigurationResponse putRegistryScanningConfiguration(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the scanning configuration for your private registry.
- Parameters:
putRegistryScanningConfigurationRequest-- Returns:
- Result of the PutRegistryScanningConfiguration 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putRegistryScanningConfiguration
default PutRegistryScanningConfigurationResponse putRegistryScanningConfiguration(Consumer<PutRegistryScanningConfigurationRequest.Builder> putRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the scanning configuration for your private registry.
This is a convenience which creates an instance of the
PutRegistryScanningConfigurationRequest.Builderavoiding the need to create one manually viaPutRegistryScanningConfigurationRequest.builder()- Parameters:
putRegistryScanningConfigurationRequest- AConsumerthat will call methods onPutRegistryScanningConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutRegistryScanningConfiguration 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putReplicationConfiguration
default PutReplicationConfigurationResponse putReplicationConfiguration(PutReplicationConfigurationRequest putReplicationConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putReplicationConfiguration
default PutReplicationConfigurationResponse putReplicationConfiguration(Consumer<PutReplicationConfigurationRequest.Builder> putReplicationConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the
PutReplicationConfigurationRequest.Builderavoiding the need to create one manually viaPutReplicationConfigurationRequest.builder()- Parameters:
putReplicationConfigurationRequest- AConsumerthat will call methods onPutReplicationConfigurationRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setRepositoryPolicy
default SetRepositoryPolicyResponse setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setRepositoryPolicy
default SetRepositoryPolicyResponse setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the
SetRepositoryPolicyRequest.Builderavoiding the need to create one manually viaSetRepositoryPolicyRequest.builder()- Parameters:
setRepositoryPolicyRequest- AConsumerthat will call methods onSetRepositoryPolicyRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startImageScan
default StartImageScanResponse startImageScan(StartImageScanRequest startImageScanRequest) throws ServerException, InvalidParameterException, UnsupportedImageTypeException, LimitExceededException, RepositoryNotFoundException, ImageNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startImageScan
default StartImageScanResponse startImageScan(Consumer<StartImageScanRequest.Builder> startImageScanRequest) throws ServerException, InvalidParameterException, UnsupportedImageTypeException, LimitExceededException, RepositoryNotFoundException, ImageNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the
StartImageScanRequest.Builderavoiding the need to create one manually viaStartImageScanRequest.builder()- Parameters:
startImageScanRequest- AConsumerthat will call methods onStartImageScanRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startLifecyclePolicyPreview
default StartLifecyclePolicyPreviewResponse startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, LifecyclePolicyPreviewInProgressException, ValidationException, AwsServiceException, SdkClientException, EcrException
Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
- Parameters:
startLifecyclePolicyPreviewRequest-- Returns:
- Result of the StartLifecyclePolicyPreview 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.LifecyclePolicyNotFoundException- The lifecycle policy could not be found, and no policy is set to the repository.LifecyclePolicyPreviewInProgressException- The previous lifecycle policy preview request has not completed. Wait and try again.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startLifecyclePolicyPreview
default StartLifecyclePolicyPreviewResponse startLifecyclePolicyPreview(Consumer<StartLifecyclePolicyPreviewRequest.Builder> startLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, LifecyclePolicyPreviewInProgressException, ValidationException, AwsServiceException, SdkClientException, EcrException
Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
This is a convenience which creates an instance of the
StartLifecyclePolicyPreviewRequest.Builderavoiding the need to create one manually viaStartLifecyclePolicyPreviewRequest.builder()- Parameters:
startLifecyclePolicyPreviewRequest- AConsumerthat will call methods onStartLifecyclePolicyPreviewRequest.Builderto create a request.- Returns:
- Result of the StartLifecyclePolicyPreview 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.LifecyclePolicyNotFoundException- The lifecycle policy could not be found, and no policy is set to the repository.LifecyclePolicyPreviewInProgressException- The previous lifecycle policy preview request has not completed. Wait and try again.ValidationException- There was an exception validating this request.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
Deletes specified tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePullThroughCacheRule
default UpdatePullThroughCacheRuleResponse updatePullThroughCacheRule(UpdatePullThroughCacheRuleRequest updatePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, UnableToAccessSecretException, PullThroughCacheRuleNotFoundException, SecretNotFoundException, UnableToDecryptSecretValueException, AwsServiceException, SdkClientException, EcrException
Updates an existing pull through cache rule.
- Parameters:
updatePullThroughCacheRuleRequest-- Returns:
- Result of the UpdatePullThroughCacheRule 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.UnableToAccessSecretException- The secret is unable to be accessed. Verify the resource permissions for the secret and try again.PullThroughCacheRuleNotFoundException- The pull through cache rule was not found. Specify a valid pull through cache rule and try again.SecretNotFoundException- The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.UnableToDecryptSecretValueException- The secret is accessible but is unable to be decrypted. Verify the resource permisisons and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updatePullThroughCacheRule
default UpdatePullThroughCacheRuleResponse updatePullThroughCacheRule(Consumer<UpdatePullThroughCacheRuleRequest.Builder> updatePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, UnableToAccessSecretException, PullThroughCacheRuleNotFoundException, SecretNotFoundException, UnableToDecryptSecretValueException, AwsServiceException, SdkClientException, EcrException
Updates an existing pull through cache rule.
This is a convenience which creates an instance of the
UpdatePullThroughCacheRuleRequest.Builderavoiding the need to create one manually viaUpdatePullThroughCacheRuleRequest.builder()- Parameters:
updatePullThroughCacheRuleRequest- AConsumerthat will call methods onUpdatePullThroughCacheRuleRequest.Builderto create a request.- Returns:
- Result of the UpdatePullThroughCacheRule 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.UnableToAccessSecretException- The secret is unable to be accessed. Verify the resource permissions for the secret and try again.PullThroughCacheRuleNotFoundException- The pull through cache rule was not found. Specify a valid pull through cache rule and try again.SecretNotFoundException- The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.UnableToDecryptSecretValueException- The secret is accessible but is unable to be decrypted. Verify the resource permisisons and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateRepositoryCreationTemplate
default UpdateRepositoryCreationTemplateResponse updateRepositoryCreationTemplate(UpdateRepositoryCreationTemplateRequest updateRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, TemplateNotFoundException, AwsServiceException, SdkClientException, EcrException
Updates an existing repository creation template.
- Parameters:
updateRepositoryCreationTemplateRequest-- Returns:
- Result of the UpdateRepositoryCreationTemplate 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.TemplateNotFoundException- The specified repository creation template can't be found. Verify the registry ID and prefix and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateRepositoryCreationTemplate
default UpdateRepositoryCreationTemplateResponse updateRepositoryCreationTemplate(Consumer<UpdateRepositoryCreationTemplateRequest.Builder> updateRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, TemplateNotFoundException, AwsServiceException, SdkClientException, EcrException
Updates an existing repository creation template.
This is a convenience which creates an instance of the
UpdateRepositoryCreationTemplateRequest.Builderavoiding the need to create one manually viaUpdateRepositoryCreationTemplateRequest.builder()- Parameters:
updateRepositoryCreationTemplateRequest- AConsumerthat will call methods onUpdateRepositoryCreationTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateRepositoryCreationTemplate 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.TemplateNotFoundException- The specified repository creation template can't be found. Verify the registry ID and prefix and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
uploadLayerPart
default UploadLayerPartResponse uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
uploadLayerPart
default UploadLayerPartResponse uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException
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
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
UploadLayerPartRequest.Builderavoiding the need to create one manually viaUploadLayerPartRequest.builder()- Parameters:
uploadLayerPartRequest- AConsumerthat will call methods onUploadLayerPartRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
validatePullThroughCacheRule
default ValidatePullThroughCacheRuleResponse validatePullThroughCacheRule(ValidatePullThroughCacheRuleRequest validatePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
validatePullThroughCacheRule
default ValidatePullThroughCacheRuleResponse validatePullThroughCacheRule(Consumer<ValidatePullThroughCacheRuleRequest.Builder> validatePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the
ValidatePullThroughCacheRuleRequest.Builderavoiding the need to create one manually viaValidatePullThroughCacheRuleRequest.builder()- Parameters:
validatePullThroughCacheRuleRequest- AConsumerthat will call methods onValidatePullThroughCacheRuleRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default EcrWaiter waiter()
Create an instance ofEcrWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
EcrWaiter
-
create
static EcrClient create()
Create aEcrClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static EcrClientBuilder builder()
Create a builder that can be used to configure and create aEcrClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default EcrServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-