Struct aws_sdk_ecrpublic::client::fluent_builders::DescribeImages

pub struct DescribeImages { /* private fields */ }

Fluent builder constructing a request to DescribeImages.

Returns metadata that's related to the images in a repository in a public registry.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages.

Implementations

impl DescribeImages

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeImages, AwsResponseRetryClassifier>, SdkError<DescribeImagesError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeImagesOutput, SdkError<DescribeImagesError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeImagesPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn registry_id(self, input: impl Into<String>) -> Self

The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

pub fn set_registry_id(self, input: Option<String>) -> Self

The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

pub fn repository_name(self, input: impl Into<String>) -> Self

The repository that contains the images to describe.

pub fn set_repository_name(self, input: Option<String>) -> Self

The repository that contains the images to describe.

pub fn image_ids(self, input: ImageIdentifier) -> Self

Appends an item to imageIds.

To override the contents of this collection use set_image_ids.

The list of image IDs for the requested repository.

pub fn set_image_ids(self, input: Option<Vec<ImageIdentifier>>) -> Self

The list of image IDs for the requested repository.

pub fn next_token(self, input: impl Into<String>) -> Self

The nextToken value that's 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. If there are no more results to return, this value is null. If you specify images with imageIds, you can't use this option.

pub fn set_next_token(self, input: Option<String>) -> Self

The nextToken value that's 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. If there are no more results to return, this value is null. If you specify images with imageIds, you can't use this option.

pub fn max_results(self, input: i32) -> Self

The maximum number of repository results that's 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. You can see the remaining results of the initial request by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can't use this option.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of repository results that's 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. You can see the remaining results of the initial request by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can't use this option.

Trait Implementations

impl Clone for DescribeImages

fn clone(&self) -> DescribeImages

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeImages

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

Formats the value using the given formatter.