aws_sdk_datazone/client/
list_projects.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListProjects`](crate::operation::list_projects::builders::ListProjectsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_identifier(impl Into<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The identifier of the Amazon DataZone domain.</p><br>
    ///   - [`user_identifier(impl Into<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::user_identifier) / [`set_user_identifier(Option<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::set_user_identifier):<br>required: **false**<br><p>The identifier of the Amazon DataZone user.</p><br>
    ///   - [`group_identifier(impl Into<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::group_identifier) / [`set_group_identifier(Option<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::set_group_identifier):<br>required: **false**<br><p>The identifier of a group.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::set_name):<br>required: **false**<br><p>The name of the project.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::set_next_token):<br>required: **false**<br><p>When the number of projects is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of projects, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListProjects</code> to list the next set of projects.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_projects::builders::ListProjectsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of projects to return in a single call to <code>ListProjects</code>. When the number of projects to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListProjects</code> to list the next set of projects.</p><br>
    /// - On success, responds with [`ListProjectsOutput`](crate::operation::list_projects::ListProjectsOutput) with field(s):
    ///   - [`items(Option<Vec::<ProjectSummary>>)`](crate::operation::list_projects::ListProjectsOutput::items): <p>The results of the <code>ListProjects</code> action.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_projects::ListProjectsOutput::next_token): <p>When the number of projects is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of projects, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListProjects</code> to list the next set of projects.</p>
    /// - On failure, responds with [`SdkError<ListProjectsError>`](crate::operation::list_projects::ListProjectsError)
    pub fn list_projects(&self) -> crate::operation::list_projects::builders::ListProjectsFluentBuilder {
        crate::operation::list_projects::builders::ListProjectsFluentBuilder::new(self.handle.clone())
    }
}