aws_sdk_ecr/client/

list_image_referrers.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListImageReferrers`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`registry_id(impl Into<String>)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::registry_id) / [`set_registry_id(Option<String>)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::set_registry_id):<br>required: **false**<br><p>The Amazon Web Services account ID associated with the registry that contains the repository in which to list image referrers. If you do not specify a registry, the default registry is assumed.</p><br>
    ///   - [`repository_name(impl Into<String>)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::repository_name) / [`set_repository_name(Option<String>)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::set_repository_name):<br>required: **true**<br><p>The name of the repository that contains the subject image.</p><br>
    ///   - [`subject_id(SubjectIdentifier)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::subject_id) / [`set_subject_id(Option<SubjectIdentifier>)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::set_subject_id):<br>required: **true**<br><p>An object containing the image digest of the subject image for which to retrieve associated artifacts.</p><br>
    ///   - [`filter(ListImageReferrersFilter)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::filter) / [`set_filter(Option<ListImageReferrersFilter>)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::set_filter):<br>required: **false**<br><p>The filter key and value with which to filter your <code>ListImageReferrers</code> results. If no filter is specified, only artifacts with <code>ACTIVE</code> status are returned.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a previous paginated <code>ListImageReferrers</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. This value is <code>null</code> when there are no more results to return.</p><note>  <p>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.</p> </note><br>
    ///   - [`max_results(i32)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of image referrer results returned by <code>ListImageReferrers</code> in paginated output. When this parameter is used, <code>ListImageReferrers</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListImageReferrers</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 50. If this parameter is not used, then <code>ListImageReferrers</code> returns up to 50 results and a <code>nextToken</code> value, if applicable.</p><br>
    /// - On success, responds with [`ListImageReferrersOutput`](crate::operation::list_image_referrers::ListImageReferrersOutput) with field(s):
    ///   - [`referrers(Option<Vec::<ImageReferrer>>)`](crate::operation::list_image_referrers::ListImageReferrersOutput::referrers): <p>The list of artifacts associated with the subject image.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_image_referrers::ListImageReferrersOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListImageReferrers</code> request. When the results of a <code>ListImageReferrers</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<ListImageReferrersError>`](crate::operation::list_image_referrers::ListImageReferrersError)
    pub fn list_image_referrers(&self) -> crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder {
        crate::operation::list_image_referrers::builders::ListImageReferrersFluentBuilder::new(self.handle.clone())
    }
}