aws_sdk_sagemaker/client/
list_aliases.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 [`ListAliases`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`image_name(impl Into<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::image_name) / [`set_image_name(Option<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::set_image_name):<br>required: **true**<br><p>The name of the image.</p><br>
8    ///   - [`alias(impl Into<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::alias) / [`set_alias(Option<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::set_alias):<br>required: **false**<br><p>The alias of the image version.</p><br>
9    ///   - [`version(i32)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::version) / [`set_version(Option<i32>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::set_version):<br>required: **false**<br><p>The version of the image. If image version is not specified, the aliases of all versions of the image are listed.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of aliases to return.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_aliases::builders::ListAliasesFluentBuilder::set_next_token):<br>required: **false**<br><p>If the previous call to <code>ListAliases</code> didn't return the full set of aliases, the call returns a token for retrieving the next set of aliases.</p><br>
12    /// - On success, responds with [`ListAliasesOutput`](crate::operation::list_aliases::ListAliasesOutput) with field(s):
13    ///   - [`sage_maker_image_version_aliases(Option<Vec::<String>>)`](crate::operation::list_aliases::ListAliasesOutput::sage_maker_image_version_aliases): <p>A list of SageMaker AI image version aliases.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_aliases::ListAliasesOutput::next_token): <p>A token for getting the next set of aliases, if more aliases exist.</p>
15    /// - On failure, responds with [`SdkError<ListAliasesError>`](crate::operation::list_aliases::ListAliasesError)
16    pub fn list_aliases(&self) -> crate::operation::list_aliases::builders::ListAliasesFluentBuilder {
17        crate::operation::list_aliases::builders::ListAliasesFluentBuilder::new(self.handle.clone())
18    }
19}