Struct aws_sdk_ecr::client::fluent_builders::ListImages

pub struct ListImages { /* private fields */ }

Fluent builder constructing a request to ListImages.

Lists all the image IDs for the specified repository.

You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

Implementations

impl ListImages

pub async fn send(self) -> Result<ListImagesOutput, SdkError<ListImagesError>>

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) -> ListImagesPaginator

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 list 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 list 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 with image IDs to be listed.

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

The repository with image IDs to be listed.

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

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.

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

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.

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

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.

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

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.

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

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

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

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

Trait Implementations

impl Clone for ListImages

fn clone(&self) -> ListImages

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListImages

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

Formats the value using the given formatter.