aws_sdk_datazone/client/
list_subscription_grants.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListSubscriptionGrants`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_identifier(impl Into<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The identifier of the Amazon DataZone domain.</p><br>
    ///   - [`environment_id(impl Into<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_environment_id):<br>required: **false**<br><p>The identifier of the Amazon DataZone environment.</p><br>
    ///   - [`subscription_target_id(impl Into<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::subscription_target_id) / [`set_subscription_target_id(Option<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_subscription_target_id):<br>required: **false**<br><p>The identifier of the subscription target.</p><br>
    ///   - [`subscribed_listing_id(impl Into<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::subscribed_listing_id) / [`set_subscribed_listing_id(Option<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_subscribed_listing_id):<br>required: **false**<br><p>The identifier of the subscribed listing.</p><br>
    ///   - [`subscription_id(impl Into<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::subscription_id) / [`set_subscription_id(Option<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_subscription_id):<br>required: **false**<br><p>The identifier of the subscription.</p><br>
    ///   - [`owning_project_id(impl Into<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::owning_project_id) / [`set_owning_project_id(Option<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_owning_project_id):<br>required: **false**<br><p>The ID of the owning project of the subscription grants.</p><br>
    ///   - [`sort_by(SortKey)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::sort_by) / [`set_sort_by(Option<SortKey>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_sort_by):<br>required: **false**<br><p>Specifies the way of sorting the results of this action.</p><br>
    ///   - [`sort_order(SortOrder)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_sort_order):<br>required: **false**<br><p>Specifies the sort order of this action.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of subscription grants to return in a single call to <code>ListSubscriptionGrants</code>. When the number of subscription 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>ListSubscriptionGrants</code> to list the next set of subscription grants.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::set_next_token):<br>required: **false**<br><p>When the number of subscription 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 subscription 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>ListSubscriptionGrants</code> to list the next set of subscription grants.</p><br>
    /// - On success, responds with [`ListSubscriptionGrantsOutput`](crate::operation::list_subscription_grants::ListSubscriptionGrantsOutput) with field(s):
    ///   - [`items(Vec::<SubscriptionGrantSummary>)`](crate::operation::list_subscription_grants::ListSubscriptionGrantsOutput::items): <p>The results of the <code>ListSubscriptionGrants</code> action.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_subscription_grants::ListSubscriptionGrantsOutput::next_token): <p>When the number of subscription 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 subscription 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>ListSubscriptionGrants</code> to list the next set of subscription grants.</p>
    /// - On failure, responds with [`SdkError<ListSubscriptionGrantsError>`](crate::operation::list_subscription_grants::ListSubscriptionGrantsError)
    pub fn list_subscription_grants(&self) -> crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder {
        crate::operation::list_subscription_grants::builders::ListSubscriptionGrantsFluentBuilder::new(self.handle.clone())
    }
}