aws_sdk_datazone/client/
list_policy_grants.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 [`ListPolicyGrants`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_identifier(impl Into<String>)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The ID of the domain where you want to list policy grants.</p><br>
    ///   - [`entity_type(TargetEntityType)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::entity_type) / [`set_entity_type(Option<TargetEntityType>)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::set_entity_type):<br>required: **true**<br><p>The type of entity for which you want to list policy grants.</p><br>
    ///   - [`entity_identifier(impl Into<String>)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::entity_identifier) / [`set_entity_identifier(Option<String>)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::set_entity_identifier):<br>required: **true**<br><p>The ID of the entity for which you want to list policy grants.</p><br>
    ///   - [`policy_type(ManagedPolicyType)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::policy_type) / [`set_policy_type(Option<ManagedPolicyType>)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::set_policy_type):<br>required: **true**<br><p>The type of policy that you want to list.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of grants to return in a single call to <code>ListPolicyGrants</code>. When the number of grants 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>ListPolicyGrants</code> to list the next set of grants.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::set_next_token):<br>required: **false**<br><p>When the number of grants 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 grants, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListPolicyGrants</code> to list the next set of grants.</p><br>
    /// - On success, responds with [`ListPolicyGrantsOutput`](crate::operation::list_policy_grants::ListPolicyGrantsOutput) with field(s):
    ///   - [`grant_list(Vec::<PolicyGrantMember>)`](crate::operation::list_policy_grants::ListPolicyGrantsOutput::grant_list): <p>The results of this action - the listed grants.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_policy_grants::ListPolicyGrantsOutput::next_token): <p>When the number of grants 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 grants, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListPolicyGrants</code> to list the next set of grants.</p>
    /// - On failure, responds with [`SdkError<ListPolicyGrantsError>`](crate::operation::list_policy_grants::ListPolicyGrantsError)
    pub fn list_policy_grants(&self) -> crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder {
        crate::operation::list_policy_grants::builders::ListPolicyGrantsFluentBuilder::new(self.handle.clone())
    }
}