Struct aws_sdk_ecr::Client

pub struct Client { /* private fields */ }

Client for Amazon EC2 Container Registry

Client for invoking operations on Amazon EC2 Container Registry. Each operation on Amazon EC2 Container Registry is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_ecr::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_ecr::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the BatchCheckLayerAvailability operation has a Client::batch_check_layer_availability, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.batch_check_layer_availability()
    .registry_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_check_layer_availability( &self ) -> BatchCheckLayerAvailabilityFluentBuilder

Constructs a fluent builder for the BatchCheckLayerAvailability operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository that is associated with the image layers to check.

  • layer_digests(impl Into<String>) / set_layer_digests(Option<Vec<String>>):

    The digests of the image layers to check.

• On success, responds with BatchCheckLayerAvailabilityOutput with field(s):
  • layers(Option<Vec<Layer>>):

    A list of image layer objects corresponding to the image layer references in the request.

  • failures(Option<Vec<LayerFailure>>):

    Any failures associated with the call.

• On failure, responds with SdkError<BatchCheckLayerAvailabilityError>

impl Client

pub fn batch_delete_image(&self) -> BatchDeleteImageFluentBuilder

Constructs a fluent builder for the BatchDeleteImage operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The repository that contains the image to delete.

  • image_ids(ImageIdentifier) / set_image_ids(Option<Vec<ImageIdentifier>>):

    A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

• On success, responds with BatchDeleteImageOutput with field(s):
  • image_ids(Option<Vec<ImageIdentifier>>):

    The image IDs of the deleted images.

  • failures(Option<Vec<ImageFailure>>):

    Any failures associated with the call.

• On failure, responds with SdkError<BatchDeleteImageError>

impl Client

pub fn batch_get_image(&self) -> BatchGetImageFluentBuilder

Constructs a fluent builder for the BatchGetImage operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The repository that contains the images to describe.

  • image_ids(ImageIdentifier) / set_image_ids(Option<Vec<ImageIdentifier>>):

    A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

  • accepted_media_types(impl Into<String>) / set_accepted_media_types(Option<Vec<String>>):

    The accepted media types for the request.

    Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

• On success, responds with BatchGetImageOutput with field(s):
  • images(Option<Vec<Image>>):

    A list of image objects corresponding to the image references in the request.

  • failures(Option<Vec<ImageFailure>>):

    Any failures associated with the call.

• On failure, responds with SdkError<BatchGetImageError>

impl Client

pub fn batch_get_repository_scanning_configuration( &self ) -> BatchGetRepositoryScanningConfigurationFluentBuilder

Constructs a fluent builder for the BatchGetRepositoryScanningConfiguration operation.

• The fluent builder is configurable:
  • repository_names(impl Into<String>) / set_repository_names(Option<Vec<String>>):

    One or more repository names to get the scanning configuration for.

• On success, responds with BatchGetRepositoryScanningConfigurationOutput with field(s):
  • scanning_configurations(Option<Vec<RepositoryScanningConfiguration>>):

    The scanning configuration for the requested repositories.

  • failures(Option<Vec<RepositoryScanningConfigurationFailure>>):

    Any failures associated with the call.

• On failure, responds with SdkError<BatchGetRepositoryScanningConfigurationError>

impl Client

pub fn complete_layer_upload(&self) -> CompleteLayerUploadFluentBuilder

Constructs a fluent builder for the CompleteLayerUpload operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository to associate with the image layer.

  • upload_id(impl Into<String>) / set_upload_id(Option<String>):

    The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.

  • layer_digests(impl Into<String>) / set_layer_digests(Option<Vec<String>>):

    The sha256 digest of the image layer.

• On success, responds with CompleteLayerUploadOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • upload_id(Option<String>):

    The upload ID associated with the layer.

  • layer_digest(Option<String>):

    The sha256 digest of the image layer.

• On failure, responds with SdkError<CompleteLayerUploadError>

impl Client

pub fn create_pull_through_cache_rule( &self ) -> CreatePullThroughCacheRuleFluentBuilder

Constructs a fluent builder for the CreatePullThroughCacheRule operation.

• The fluent builder is configurable:
  • ecr_repository_prefix(impl Into<String>) / set_ecr_repository_prefix(Option<String>):

    The repository name prefix to use when caching images from the source registry.

  • upstream_registry_url(impl Into<String>) / set_upstream_registry_url(Option<String>):

    The registry URL of the upstream public registry to use as the source for the pull through cache rule.

  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If you do not specify a registry, the default registry is assumed.

• On success, responds with CreatePullThroughCacheRuleOutput with field(s):
  • ecr_repository_prefix(Option<String>):

    The Amazon ECR repository prefix associated with the pull through cache rule.

  • upstream_registry_url(Option<String>):

    The upstream registry URL associated with the pull through cache rule.

  • created_at(Option<DateTime>):

    The date and time, in JavaScript date format, when the pull through cache rule was created.

  • registry_id(Option<String>):

    The registry ID associated with the request.

• On failure, responds with SdkError<CreatePullThroughCacheRuleError>

impl Client

pub fn create_repository(&self) -> CreateRepositoryFluentBuilder

Constructs a fluent builder for the CreateRepository operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry to create the repository. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).

  • tags(Tag) / set_tags(Option<Vec<Tag>>):

    The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

  • image_tag_mutability(ImageTagMutability) / set_image_tag_mutability(Option<ImageTagMutability>):

    The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

  • image_scanning_configuration(ImageScanningConfiguration) / set_image_scanning_configuration(Option<ImageScanningConfiguration>):

    The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.

  • encryption_configuration(EncryptionConfiguration) / set_encryption_configuration(Option<EncryptionConfiguration>):

    The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.

• On success, responds with CreateRepositoryOutput with field(s):
  • repository(Option<Repository>):

    The repository that was created.

• On failure, responds with SdkError<CreateRepositoryError>

impl Client

pub fn delete_lifecycle_policy(&self) -> DeleteLifecyclePolicyFluentBuilder

Constructs a fluent builder for the DeleteLifecyclePolicy operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository.

• On success, responds with DeleteLifecyclePolicyOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • lifecycle_policy_text(Option<String>):

    The JSON lifecycle policy text.

  • last_evaluated_at(Option<DateTime>):

    The time stamp of the last time that the lifecycle policy was run.

• On failure, responds with SdkError<DeleteLifecyclePolicyError>

impl Client

pub fn delete_pull_through_cache_rule( &self ) -> DeletePullThroughCacheRuleFluentBuilder

Constructs a fluent builder for the DeletePullThroughCacheRule operation.

• The fluent builder is configurable:
  • ecr_repository_prefix(impl Into<String>) / set_ecr_repository_prefix(Option<String>):

    The Amazon ECR repository prefix associated with the pull through cache rule to delete.

  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the pull through cache rule. If you do not specify a registry, the default registry is assumed.

• On success, responds with DeletePullThroughCacheRuleOutput with field(s):
  • ecr_repository_prefix(Option<String>):

    The Amazon ECR repository prefix associated with the request.

  • upstream_registry_url(Option<String>):

    The upstream registry URL associated with the pull through cache rule.

  • created_at(Option<DateTime>):

    The timestamp associated with the pull through cache rule.

  • registry_id(Option<String>):

    The registry ID associated with the request.

• On failure, responds with SdkError<DeletePullThroughCacheRuleError>

impl Client

pub fn delete_registry_policy(&self) -> DeleteRegistryPolicyFluentBuilder

Constructs a fluent builder for the DeleteRegistryPolicy operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteRegistryPolicyOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • policy_text(Option<String>):

    The contents of the registry permissions policy that was deleted.

• On failure, responds with SdkError<DeleteRegistryPolicyError>

impl Client

pub fn delete_repository(&self) -> DeleteRepositoryFluentBuilder

Constructs a fluent builder for the DeleteRepository operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository to delete.

  • force(bool) / set_force(bool):

    If a repository contains images, forces the deletion.

• On success, responds with DeleteRepositoryOutput with field(s):
  • repository(Option<Repository>):

    The repository that was deleted.

• On failure, responds with SdkError<DeleteRepositoryError>

impl Client

pub fn delete_repository_policy(&self) -> DeleteRepositoryPolicyFluentBuilder

Constructs a fluent builder for the DeleteRepositoryPolicy operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository that is associated with the repository policy to delete.

• On success, responds with DeleteRepositoryPolicyOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • policy_text(Option<String>):

    The JSON repository policy that was deleted from the repository.

• On failure, responds with SdkError<DeleteRepositoryPolicyError>

impl Client

pub fn describe_image_replication_status( &self ) -> DescribeImageReplicationStatusFluentBuilder

Constructs a fluent builder for the DescribeImageReplicationStatus operation.

• The fluent builder is configurable:
  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository that the image is in.

  • image_id(ImageIdentifier) / set_image_id(Option<ImageIdentifier>):

    An object with identifying information for an image in an Amazon ECR repository.

  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.

• On success, responds with DescribeImageReplicationStatusOutput with field(s):
  • repository_name(Option<String>):

    The repository name associated with the request.

  • image_id(Option<ImageIdentifier>):

    An object with identifying information for an image in an Amazon ECR repository.

  • replication_statuses(Option<Vec<ImageReplicationStatus>>):

    The replication status details for the images in the specified repository.

• On failure, responds with SdkError<DescribeImageReplicationStatusError>

impl Client

pub fn describe_image_scan_findings( &self ) -> DescribeImageScanFindingsFluentBuilder

Constructs a fluent builder for the DescribeImageScanFindings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The repository for the image for which to describe the scan findings.

  • image_id(ImageIdentifier) / set_image_id(Option<ImageIdentifier>):

    An object with identifying information for an image in an Amazon ECR repository.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken value returned from a previous paginated DescribeImageScanFindings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.

• On success, responds with DescribeImageScanFindingsOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • image_id(Option<ImageIdentifier>):

    An object with identifying information for an image in an Amazon ECR repository.

  • image_scan_status(Option<ImageScanStatus>):

    The current state of the scan.

  • image_scan_findings(Option<ImageScanFindings>):

    The information contained in the image scan findings.

  • next_token(Option<String>):

    The nextToken value to include in a future DescribeImageScanFindings request. When the results of a DescribeImageScanFindings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeImageScanFindingsError>

impl Client

pub fn describe_images(&self) -> DescribeImagesFluentBuilder

Constructs a fluent builder for the DescribeImages operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The repository that contains the images to describe.

  • image_ids(ImageIdentifier) / set_image_ids(Option<Vec<ImageIdentifier>>):

    The list of image IDs for the requested repository.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

  • filter(DescribeImagesFilter) / set_filter(Option<DescribeImagesFilter>):

    The filter key and value with which to filter your DescribeImages results.

• On success, responds with DescribeImagesOutput with field(s):
  • image_details(Option<Vec<ImageDetail>>):

    A list of ImageDetail objects that contain data about the image.

  • next_token(Option<String>):

    The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeImagesError>

impl Client

pub fn describe_pull_through_cache_rules( &self ) -> DescribePullThroughCacheRulesFluentBuilder

Constructs a fluent builder for the DescribePullThroughCacheRules operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If you do not specify a registry, the default registry is assumed.

  • ecr_repository_prefixes(impl Into<String>) / set_ecr_repository_prefixes(Option<Vec<String>>):

    The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository prefix value is specified, all pull through cache rules are returned.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken value returned from a previous paginated DescribePullThroughCacheRulesRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribePullThroughCacheRulesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value, if applicable.

• On success, responds with DescribePullThroughCacheRulesOutput with field(s):
  • pull_through_cache_rules(Option<Vec<PullThroughCacheRule>>):

    The details of the pull through cache rules.

  • next_token(Option<String>):

    The nextToken value to include in a future DescribePullThroughCacheRulesRequest request. When the results of a DescribePullThroughCacheRulesRequest request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribePullThroughCacheRulesError>

impl Client

pub fn describe_registry(&self) -> DescribeRegistryFluentBuilder

Constructs a fluent builder for the DescribeRegistry operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeRegistryOutput with field(s):
  • registry_id(Option<String>):

    The ID of the registry.

  • replication_configuration(Option<ReplicationConfiguration>):

    The replication configuration for the registry.

• On failure, responds with SdkError<DescribeRegistryError>

impl Client

pub fn describe_repositories(&self) -> DescribeRepositoriesFluentBuilder

Constructs a fluent builder for the DescribeRepositories operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

  • repository_names(impl Into<String>) / set_repository_names(Option<Vec<String>>):

    A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify repositories with repositoryNames.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

• On success, responds with DescribeRepositoriesOutput with field(s):
  • repositories(Option<Vec<Repository>>):

    A list of repository objects corresponding to valid repositories.

  • next_token(Option<String>):

    The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeRepositoriesError>

impl Client

pub fn get_authorization_token(&self) -> GetAuthorizationTokenFluentBuilder

Constructs a fluent builder for the GetAuthorizationToken operation.

• The fluent builder is configurable:
  • registry_ids(impl Into<String>) / set_registry_ids(Option<Vec<String>>):

    A list of Amazon Web Services account IDs that are associated with the registries for which to get AuthorizationData objects. If you do not specify a registry, the default registry is assumed.

• On success, responds with GetAuthorizationTokenOutput with field(s):
  • authorization_data(Option<Vec<AuthorizationData>>):

    A list of authorization token data objects that correspond to the registryIds values in the request.

• On failure, responds with SdkError<GetAuthorizationTokenError>

impl Client

pub fn get_download_url_for_layer(&self) -> GetDownloadUrlForLayerFluentBuilder

Constructs a fluent builder for the GetDownloadUrlForLayer operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository that is associated with the image layer to download.

  • layer_digest(impl Into<String>) / set_layer_digest(Option<String>):

    The digest of the image layer to download.

• On success, responds with GetDownloadUrlForLayerOutput with field(s):
  • download_url(Option<String>):

    The pre-signed Amazon S3 download URL for the requested layer.

  • layer_digest(Option<String>):

    The digest of the image layer to download.

• On failure, responds with SdkError<GetDownloadUrlForLayerError>

impl Client

pub fn get_lifecycle_policy(&self) -> GetLifecyclePolicyFluentBuilder

Constructs a fluent builder for the GetLifecyclePolicy operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository.

• On success, responds with GetLifecyclePolicyOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • lifecycle_policy_text(Option<String>):

    The JSON lifecycle policy text.

  • last_evaluated_at(Option<DateTime>):

    The time stamp of the last time that the lifecycle policy was run.

• On failure, responds with SdkError<GetLifecyclePolicyError>

impl Client

pub fn get_lifecycle_policy_preview( &self ) -> GetLifecyclePolicyPreviewFluentBuilder

Constructs a fluent builder for the GetLifecyclePolicyPreview operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository.

  • image_ids(ImageIdentifier) / set_image_ids(Option<Vec<ImageIdentifier>>):

    The list of imageIDs to be included.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest request where maxResults was used and the
 results exceeded the value of that parameter. Pagination continues from the end of the
 previous results that returned the nextToken value. This value is
 null when there are no more results to return. This option cannot be used when you specify images with imageIds.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a single page along with a nextToken
 response element. The remaining results of the initial request can be seen by sending
 another GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. This value can be between 1 and 1000. If this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken value, if
 applicable. This option cannot be used when you specify images with imageIds.

  • filter(LifecyclePolicyPreviewFilter) / set_filter(Option<LifecyclePolicyPreviewFilter>):

    An optional parameter that filters results based on image tag status and all tags, if tagged.

• On success, responds with GetLifecyclePolicyPreviewOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • lifecycle_policy_text(Option<String>):

    The JSON lifecycle policy text.

  • status(Option<LifecyclePolicyPreviewStatus>):

    The status of the lifecycle policy preview request.

  • next_token(Option<String>):

    The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

  • preview_results(Option<Vec<LifecyclePolicyPreviewResult>>):

    The results of the lifecycle policy preview request.

  • summary(Option<LifecyclePolicyPreviewSummary>):

    The list of images that is returned as a result of the action.

• On failure, responds with SdkError<GetLifecyclePolicyPreviewError>

impl Client

pub fn get_registry_policy(&self) -> GetRegistryPolicyFluentBuilder

Constructs a fluent builder for the GetRegistryPolicy operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetRegistryPolicyOutput with field(s):
  • registry_id(Option<String>):

    The ID of the registry.

  • policy_text(Option<String>):

    The JSON text of the permissions policy for a registry.

• On failure, responds with SdkError<GetRegistryPolicyError>

impl Client

pub fn get_registry_scanning_configuration( &self ) -> GetRegistryScanningConfigurationFluentBuilder

Constructs a fluent builder for the GetRegistryScanningConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetRegistryScanningConfigurationOutput with field(s):
  • registry_id(Option<String>):

    The ID of the registry.

  • scanning_configuration(Option<RegistryScanningConfiguration>):

    The scanning configuration for the registry.

• On failure, responds with SdkError<GetRegistryScanningConfigurationError>

impl Client

pub fn get_repository_policy(&self) -> GetRepositoryPolicyFluentBuilder

Constructs a fluent builder for the GetRepositoryPolicy operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository with the policy to retrieve.

• On success, responds with GetRepositoryPolicyOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • policy_text(Option<String>):

    The JSON repository policy text associated with the repository.

• On failure, responds with SdkError<GetRepositoryPolicyError>

impl Client

pub fn initiate_layer_upload(&self) -> InitiateLayerUploadFluentBuilder

Constructs a fluent builder for the InitiateLayerUpload operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository to which you intend to upload layers.

• On success, responds with InitiateLayerUploadOutput with field(s):
  • upload_id(Option<String>):

    The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.

  • part_size(Option<i64>):

    The size, in bytes, that Amazon ECR expects future layer part uploads to be.

• On failure, responds with SdkError<InitiateLayerUploadError>

impl Client

pub fn list_images(&self) -> ListImagesFluentBuilder

Constructs a fluent builder for the ListImages operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The repository with image IDs to be listed.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • max_results(i32) / set_max_results(Option<i32>):

    The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

  • filter(ListImagesFilter) / set_filter(Option<ListImagesFilter>):

    The filter key and value with which to filter your ListImages results.

• On success, responds with ListImagesOutput with field(s):
  • image_ids(Option<Vec<ImageIdentifier>>):

    The list of image IDs for the requested repository.

  • next_token(Option<String>):

    The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListImagesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only supported resource is an Amazon ECR repository.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec<Tag>>):

    The tags for the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_image(&self) -> PutImageFluentBuilder

Constructs a fluent builder for the PutImage operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository in which to put the image.

  • image_manifest(impl Into<String>) / set_image_manifest(Option<String>):

    The image manifest corresponding to the image to be uploaded.

  • image_manifest_media_type(impl Into<String>) / set_image_manifest_media_type(Option<String>):

    The media type of the image manifest. If you push an image manifest that does not contain the mediaType field, you must specify the imageManifestMediaType in the request.

  • image_tag(impl Into<String>) / set_image_tag(Option<String>):

    The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.

  • image_digest(impl Into<String>) / set_image_digest(Option<String>):

    The image digest of the image manifest corresponding to the image.

• On success, responds with PutImageOutput with field(s):
  • image(Option<Image>):

    Details of the image uploaded.

• On failure, responds with SdkError<PutImageError>

impl Client

pub fn put_image_scanning_configuration( &self ) -> PutImageScanningConfigurationFluentBuilder

Constructs a fluent builder for the PutImageScanningConfiguration operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository in which to update the image scanning configuration setting. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository in which to update the image scanning configuration setting.

  • image_scanning_configuration(ImageScanningConfiguration) / set_image_scanning_configuration(Option<ImageScanningConfiguration>):

    The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.

• On success, responds with PutImageScanningConfigurationOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • image_scanning_configuration(Option<ImageScanningConfiguration>):

    The image scanning configuration setting for the repository.

• On failure, responds with SdkError<PutImageScanningConfigurationError>

impl Client

pub fn put_image_tag_mutability(&self) -> PutImageTagMutabilityFluentBuilder

Constructs a fluent builder for the PutImageTagMutability operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository in which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository in which to update the image tag mutability settings.

  • image_tag_mutability(ImageTagMutability) / set_image_tag_mutability(Option<ImageTagMutability>):

    The tag mutability setting for the repository. If MUTABLE is specified, image tags can be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

• On success, responds with PutImageTagMutabilityOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • image_tag_mutability(Option<ImageTagMutability>):

    The image tag mutability setting for the repository.

• On failure, responds with SdkError<PutImageTagMutabilityError>

impl Client

pub fn put_lifecycle_policy(&self) -> PutLifecyclePolicyFluentBuilder

Constructs a fluent builder for the PutLifecyclePolicy operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository. If you do
 not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository to receive the policy.

  • lifecycle_policy_text(impl Into<String>) / set_lifecycle_policy_text(Option<String>):

    The JSON repository policy text to apply to the repository.

• On success, responds with PutLifecyclePolicyOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • lifecycle_policy_text(Option<String>):

    The JSON repository policy text.

• On failure, responds with SdkError<PutLifecyclePolicyError>

impl Client

pub fn put_registry_policy(&self) -> PutRegistryPolicyFluentBuilder

Constructs a fluent builder for the PutRegistryPolicy operation.

• The fluent builder is configurable:
  • policy_text(impl Into<String>) / set_policy_text(Option<String>):

    The JSON policy text to apply to your registry. The policy text follows the same format as IAM policy text. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.

• On success, responds with PutRegistryPolicyOutput with field(s):
  • registry_id(Option<String>):

    The registry ID.

  • policy_text(Option<String>):

    The JSON policy text for your registry.

• On failure, responds with SdkError<PutRegistryPolicyError>

impl Client

pub fn put_registry_scanning_configuration( &self ) -> PutRegistryScanningConfigurationFluentBuilder

Constructs a fluent builder for the PutRegistryScanningConfiguration operation.

• The fluent builder is configurable:
  • scan_type(ScanType) / set_scan_type(Option<ScanType>):

    The scanning type to set for the registry.

    When a registry scanning configuration is not defined, by default the BASIC scan type is used. When basic scanning is used, you may specify filters to determine which individual repositories, or all repositories, are scanned when new images are pushed to those repositories. Alternatively, you can do manual scans of images with basic scanning.

    When the ENHANCED scan type is set, Amazon Inspector provides automated vulnerability scanning. You may choose between continuous scanning or scan on push and you may specify filters to determine which individual repositories, or all repositories, are scanned.

  • rules(RegistryScanningRule) / set_rules(Option<Vec<RegistryScanningRule>>):

    The scanning rules to use for the registry. A scanning rule is used to determine which repository filters are used and at what frequency scanning will occur.

• On success, responds with PutRegistryScanningConfigurationOutput with field(s):
  • registry_scanning_configuration(Option<RegistryScanningConfiguration>):

    The scanning configuration for your registry.

• On failure, responds with SdkError<PutRegistryScanningConfigurationError>

impl Client

pub fn put_replication_configuration( &self ) -> PutReplicationConfigurationFluentBuilder

Constructs a fluent builder for the PutReplicationConfiguration operation.

• The fluent builder is configurable:
  • replication_configuration(ReplicationConfiguration) / set_replication_configuration(Option<ReplicationConfiguration>):

    An object representing the replication configuration for a registry.

• On success, responds with PutReplicationConfigurationOutput with field(s):
  • replication_configuration(Option<ReplicationConfiguration>):

    The contents of the replication configuration for the registry.

• On failure, responds with SdkError<PutReplicationConfigurationError>

impl Client

pub fn set_repository_policy(&self) -> SetRepositoryPolicyFluentBuilder

Constructs a fluent builder for the SetRepositoryPolicy operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository to receive the policy.

  • policy_text(impl Into<String>) / set_policy_text(Option<String>):

    The JSON repository policy text to apply to the repository. For more information, see Amazon ECR repository policies in the Amazon Elastic Container Registry User Guide.

  • force(bool) / set_force(bool):

    If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs.

• On success, responds with SetRepositoryPolicyOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • policy_text(Option<String>):

    The JSON repository policy text applied to the repository.

• On failure, responds with SdkError<SetRepositoryPolicyError>

impl Client

pub fn start_image_scan(&self) -> StartImageScanFluentBuilder

Constructs a fluent builder for the StartImageScan operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository that contains the images to scan.

  • image_id(ImageIdentifier) / set_image_id(Option<ImageIdentifier>):

    An object with identifying information for an image in an Amazon ECR repository.

• On success, responds with StartImageScanOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • image_id(Option<ImageIdentifier>):

    An object with identifying information for an image in an Amazon ECR repository.

  • image_scan_status(Option<ImageScanStatus>):

    The current state of the scan.

• On failure, responds with SdkError<StartImageScanError>

impl Client

pub fn start_lifecycle_policy_preview( &self ) -> StartLifecyclePolicyPreviewFluentBuilder

Constructs a fluent builder for the StartLifecyclePolicyPreview operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository to be evaluated.

  • lifecycle_policy_text(impl Into<String>) / set_lifecycle_policy_text(Option<String>):

    The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.

• On success, responds with StartLifecyclePolicyPreviewOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • lifecycle_policy_text(Option<String>):

    The JSON repository policy text.

  • status(Option<LifecyclePolicyPreviewStatus>):

    The status of the lifecycle policy preview request.

• On failure, responds with SdkError<StartLifecyclePolicyPreviewError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.

  • tags(Tag) / set_tags(Option<Vec<Tag>>):

    The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.

  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec<String>>):

    The keys of the tags to be removed.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn upload_layer_part(&self) -> UploadLayerPartFluentBuilder

Constructs a fluent builder for the UploadLayerPart operation.

• The fluent builder is configurable:
  • registry_id(impl Into<String>) / set_registry_id(Option<String>):

    The Amazon Web Services account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.

  • repository_name(impl Into<String>) / set_repository_name(Option<String>):

    The name of the repository to which you are uploading layer parts.

  • upload_id(impl Into<String>) / set_upload_id(Option<String>):

    The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.

  • part_first_byte(i64) / set_part_first_byte(Option<i64>):

    The position of the first byte of the layer part witin the overall image layer.

  • part_last_byte(i64) / set_part_last_byte(Option<i64>):

    The position of the last byte of the layer part within the overall image layer.

  • layer_part_blob(Blob) / set_layer_part_blob(Option<Blob>):

    The base64-encoded layer part payload.

• On success, responds with UploadLayerPartOutput with field(s):
  • registry_id(Option<String>):

    The registry ID associated with the request.

  • repository_name(Option<String>):

    The repository name associated with the request.

  • upload_id(Option<String>):

    The upload ID associated with the request.

  • last_byte_received(Option<i64>):

    The integer value of the last byte received in the request.

• On failure, responds with SdkError<UploadLayerPartError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic if the conf has retry or timeouts enabled without a sleep_impl. If you experience this panic, it can be fixed by setting the sleep_impl, or by disabling retries and timeouts.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.