EcrClient Class

Member Function Documentation

EcrClient::EcrClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a EcrClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

EcrClient::EcrClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads EcrClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] BatchCheckLayerAvailabilityResponse *EcrClient::batchCheckLayerAvailability(const BatchCheckLayerAvailabilityRequest &request)

Sends request to the EcrClient service, and returns a pointer to an BatchCheckLayerAvailabilityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Check the availability of multiple image layers in a specified registry and

repository> <note>

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push

[slot] BatchDeleteImageResponse *EcrClient::batchDeleteImage(const BatchDeleteImageRequest &request)

Sends request to the EcrClient service, and returns a pointer to an BatchDeleteImageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a list of specified images within a specified repository. Images are specified with either <code>imageTag</code> or

<code>imageDigest</code>>

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

[slot] BatchGetImageResponse *EcrClient::batchGetImage(const BatchGetImageRequest &request)

Sends request to the EcrClient service, and returns a pointer to an BatchGetImageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets detailed information for specified images within a specified repository. Images are specified with either <code>imageTag</code> or

[slot] CompleteLayerUploadResponse *EcrClient::completeLayerUpload(const CompleteLayerUploadRequest &request)

Sends request to the EcrClient service, and returns a pointer to an CompleteLayerUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a <code>sha256</code> digest of the image layer for data validation

purposes> <note>

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push

[slot] CreateRepositoryResponse *EcrClient::createRepository(const CreateRepositoryRequest &request)

Sends request to the EcrClient service, and returns a pointer to an CreateRepositoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an image

[slot] DeleteLifecyclePolicyResponse *EcrClient::deleteLifecyclePolicy(const DeleteLifecyclePolicyRequest &request)

Sends request to the EcrClient service, and returns a pointer to an DeleteLifecyclePolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the specified lifecycle

[slot] DeleteRepositoryResponse *EcrClient::deleteRepository(const DeleteRepositoryRequest &request)

Sends request to the EcrClient service, and returns a pointer to an DeleteRepositoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an existing image repository. If a repository contains images, you must use the <code>force</code> option to delete

[slot] DeleteRepositoryPolicyResponse *EcrClient::deleteRepositoryPolicy(const DeleteRepositoryPolicyRequest &request)

Sends request to the EcrClient service, and returns a pointer to an DeleteRepositoryPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the repository policy from a specified

[slot] DescribeImagesResponse *EcrClient::describeImages(const DescribeImagesRequest &request)

Sends request to the EcrClient service, and returns a pointer to an DescribeImagesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns metadata about the images in a repository, including image size, image tags, and creation

date> <note>

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by

[slot] DescribeRepositoriesResponse *EcrClient::describeRepositories(const DescribeRepositoriesRequest &request)

Sends request to the EcrClient service, and returns a pointer to an DescribeRepositoriesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes image repositories in a

[slot] GetAuthorizationTokenResponse *EcrClient::getAuthorizationToken(const GetAuthorizationTokenRequest &request)

Sends request to the EcrClient service, and returns a pointer to an GetAuthorizationTokenResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the <code>docker</code> CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is

assumed>

The <code>authorizationToken</code> returned for each registry specified is a base64 encoded string that can be decoded and used in a <code>docker login</code> command to authenticate to a registry. The AWS CLI offers an <code>aws ecr get-login</code> command that simplifies the login

[slot] GetDownloadUrlForLayerResponse *EcrClient::getDownloadUrlForLayer(const GetDownloadUrlForLayerRequest &request)

Sends request to the EcrClient service, and returns a pointer to an GetDownloadUrlForLayerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <note>

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push

[slot] GetLifecyclePolicyResponse *EcrClient::getLifecyclePolicy(const GetLifecyclePolicyRequest &request)

Sends request to the EcrClient service, and returns a pointer to an GetLifecyclePolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the specified lifecycle

[slot] GetLifecyclePolicyPreviewResponse *EcrClient::getLifecyclePolicyPreview(const GetLifecyclePolicyPreviewRequest &request)

Sends request to the EcrClient service, and returns a pointer to an GetLifecyclePolicyPreviewResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the results of the specified lifecycle policy preview

[slot] GetRepositoryPolicyResponse *EcrClient::getRepositoryPolicy(const GetRepositoryPolicyRequest &request)

Sends request to the EcrClient service, and returns a pointer to an GetRepositoryPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the repository policy for a specified

[slot] InitiateLayerUploadResponse *EcrClient::initiateLayerUpload(const InitiateLayerUploadRequest &request)

Sends request to the EcrClient service, and returns a pointer to an InitiateLayerUploadResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Notify Amazon ECR that you intend to upload an image

layer> <note>

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push

[slot] ListImagesResponse *EcrClient::listImages(const ListImagesRequest &request)

Sends request to the EcrClient service, and returns a pointer to an ListImagesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all the image IDs for a given

repository>

You can filter images based on whether or not they are tagged by setting the <code>tagStatus</code> parameter to <code>TAGGED</code> or <code>UNTAGGED</code>. For example, you can filter your results to return only <code>UNTAGGED</code> images and then pipe that result to a <a>BatchDeleteImage</a> operation to delete them. Or, you can filter your results to return only <code>TAGGED</code> images to list all of the tags in your

[slot] PutImageResponse *EcrClient::putImage(const PutImageRequest &request)

Sends request to the EcrClient service, and returns a pointer to an PutImageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates or updates the image manifest and tags associated with an

image> <note>

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push

[slot] PutLifecyclePolicyResponse *EcrClient::putLifecyclePolicy(const PutLifecyclePolicyRequest &request)

Sends request to the EcrClient service, and returns a pointer to an PutLifecyclePolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see <a href="http://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html">Lifecycle Policy

[slot] SetRepositoryPolicyResponse *EcrClient::setRepositoryPolicy(const SetRepositoryPolicyRequest &request)

Sends request to the EcrClient service, and returns a pointer to an SetRepositoryPolicyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Applies a repository policy on a specified repository to control access

[slot] StartLifecyclePolicyPreviewResponse *EcrClient::startLifecyclePolicyPreview(const StartLifecyclePolicyPreviewRequest &request)

Sends request to the EcrClient service, and returns a pointer to an StartLifecyclePolicyPreviewResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle

[slot] UploadLayerPartResponse *EcrClient::uploadLayerPart(const UploadLayerPartRequest &request)

Sends request to the EcrClient service, and returns a pointer to an UploadLayerPartResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Uploads an image layer part to Amazon

ECR> <note>

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push