aws_sdk_s3control/client/
list_caller_access_grants.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListCallerAccessGrants`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`account_id(impl Into<String>)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::set_account_id):<br>required: **true**<br><p>The Amazon Web Services account ID of the S3 Access Grants instance.</p><br>
    ///   - [`grant_scope(impl Into<String>)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::grant_scope) / [`set_grant_scope(Option<String>)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::set_grant_scope):<br>required: **false**<br><p>The S3 path of the data that you would like to access. Must start with <code>s3://</code>. You can optionally pass only the beginning characters of a path, and S3 Access Grants will search for all applicable grants for the path fragment.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::set_next_token):<br>required: **false**<br><p>A pagination token to request the next page of results. Pass this value into a subsequent <code>List Caller Access Grants</code> request in order to retrieve the next page of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of access grants that you would like returned in the <code>List Caller Access Grants</code> response. If the results include the pagination token <code>NextToken</code>, make another call using the <code>NextToken</code> to determine if there are more results.</p><br>
    ///   - [`allowed_by_application(bool)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::allowed_by_application) / [`set_allowed_by_application(Option<bool>)`](crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::set_allowed_by_application):<br>required: **false**<br><p>If this optional parameter is passed in the request, a filter is applied to the results. The results will include only the access grants for the caller's Identity Center application or for any other applications (<code>ALL</code>).</p><br>
    /// - On success, responds with [`ListCallerAccessGrantsOutput`](crate::operation::list_caller_access_grants::ListCallerAccessGrantsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_caller_access_grants::ListCallerAccessGrantsOutput::next_token): <p>A pagination token that you can use to request the next page of results. Pass this value into a subsequent <code>List Caller Access Grants</code> request in order to retrieve the next page of results.</p>
    ///   - [`caller_access_grants_list(Option<Vec::<ListCallerAccessGrantsEntry>>)`](crate::operation::list_caller_access_grants::ListCallerAccessGrantsOutput::caller_access_grants_list): <p>A list of the caller's access grants that were created using S3 Access Grants and that grant the caller access to the S3 data of the Amazon Web Services account ID that was specified in the request.</p>
    /// - On failure, responds with [`SdkError<ListCallerAccessGrantsError>`](crate::operation::list_caller_access_grants::ListCallerAccessGrantsError)
    pub fn list_caller_access_grants(&self) -> crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder {
        crate::operation::list_caller_access_grants::builders::ListCallerAccessGrantsFluentBuilder::new(self.handle.clone())
    }
}