aws_sdk_ecrpublic/client/

describe_images.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeImages`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`registry_id(impl Into<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::registry_id) / [`set_registry_id(Option<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_registry_id):<br>required: **false**<br><p>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.</p><br>
    ///   - [`repository_name(impl Into<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::repository_name) / [`set_repository_name(Option<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_repository_name):<br>required: **true**<br><p>The repository that contains the images to describe.</p><br>
    ///   - [`image_ids(ImageIdentifier)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::image_ids) / [`set_image_ids(Option<Vec::<ImageIdentifier>>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_image_ids):<br>required: **false**<br><p>The list of image IDs for the requested repository.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value that's returned from a previous paginated <code>DescribeImages</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. If there are no more results to return, this value is <code>null</code>. If you specify images with <code>imageIds</code>, you can't use this option.</p><br>
    ///   - [`max_results(i32)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_images::builders::DescribeImagesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of repository results that's returned by <code>DescribeImages</code> in paginated output. When this parameter is used, <code>DescribeImages</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>DescribeImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter isn't used, then <code>DescribeImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable. If you specify images with <code>imageIds</code>, you can't use this option.</p><br>
    /// - On success, responds with [`DescribeImagesOutput`](crate::operation::describe_images::DescribeImagesOutput) with field(s):
    ///   - [`image_details(Option<Vec::<ImageDetail>>)`](crate::operation::describe_images::DescribeImagesOutput::image_details): <p>A list of <code>ImageDetail</code> objects that contain data about the image.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_images::DescribeImagesOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>DescribeImages</code> request. When the results of a <code>DescribeImages</code> request exceed <code>maxResults</code>, you can use this value to retrieve the next page of results. If there are no more results to return, this value is <code>null</code>.</p>
    /// - On failure, responds with [`SdkError<DescribeImagesError>`](crate::operation::describe_images::DescribeImagesError)
    pub fn describe_images(&self) -> crate::operation::describe_images::builders::DescribeImagesFluentBuilder {
        crate::operation::describe_images::builders::DescribeImagesFluentBuilder::new(self.handle.clone())
    }
}