aws_sdk_ecrpublic/client/
describe_registries.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeRegistries`](crate::operation::describe_registries::builders::DescribeRegistriesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_registries::builders::DescribeRegistriesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_registries::builders::DescribeRegistriesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_registries::builders::DescribeRegistriesFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value that's returned from a previous paginated <code>DescribeRegistries</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>.</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>
8    ///   - [`max_results(i32)`](crate::operation::describe_registries::builders::DescribeRegistriesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_registries::builders::DescribeRegistriesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of repository results that's returned by <code>DescribeRegistries</code> in paginated output. When this parameter is used, <code>DescribeRegistries</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>DescribeRegistries</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>DescribeRegistries</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p><br>
9    /// - On success, responds with [`DescribeRegistriesOutput`](crate::operation::describe_registries::DescribeRegistriesOutput) with field(s):
10    ///   - [`registries(Vec::<Registry>)`](crate::operation::describe_registries::DescribeRegistriesOutput::registries): <p>An object that contains the details for a public registry.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::describe_registries::DescribeRegistriesOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>DescribeRepositories</code> request. If the results of a <code>DescribeRepositories</code> request exceed <code>maxResults</code>, you can use this value to retrieve the next page of results. If there are no more results, this value is <code>null</code>.</p>
12    /// - On failure, responds with [`SdkError<DescribeRegistriesError>`](crate::operation::describe_registries::DescribeRegistriesError)
13    pub fn describe_registries(&self) -> crate::operation::describe_registries::builders::DescribeRegistriesFluentBuilder {
14        crate::operation::describe_registries::builders::DescribeRegistriesFluentBuilder::new(self.handle.clone())
15    }
16}