Struct aws_sdk_ecr::client::fluent_builders::DescribeImages

pub struct DescribeImages<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeImages.

Returns metadata about the images in a repository.

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

Implementations

impl<C, M, R> DescribeImages<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeImagesOutput, SdkError<DescribeImagesError>> where
    R::Policy: SmithyRetryPolicy<DescribeImagesInputOperationOutputAlias, DescribeImagesOutput, DescribeImagesError, DescribeImagesInputOperationRetryAlias>, 

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<C, M, R>

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

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

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.

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

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

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.

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

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.

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

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.

pub fn filter(self, input: DescribeImagesFilter) -> Self

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

pub fn set_filter(self, input: Option<DescribeImagesFilter>) -> Self

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

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for DescribeImages<C, M, R>

fn clone(&self) -> DescribeImages<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeImages<C, M, R>

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

Formats the value using the given formatter.