aws_sdk_datazone/client/

list_subscription_requests.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListSubscriptionRequests`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_identifier(impl Into<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The identifier of the Amazon DataZone domain.</p><br>
    ///   - [`status(SubscriptionRequestStatus)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::status) / [`set_status(Option<SubscriptionRequestStatus>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::set_status):<br>required: **false**<br><p>Specifies the status of the subscription requests.</p><note>  <p>This is not a required parameter, but if not specified, by default, Amazon DataZone returns only <code>PENDING</code> subscription requests.</p> </note><br>
    ///   - [`subscribed_listing_id(impl Into<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::subscribed_listing_id) / [`set_subscribed_listing_id(Option<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::set_subscribed_listing_id):<br>required: **false**<br><p>The identifier of the subscribed listing.</p><br>
    ///   - [`owning_project_id(impl Into<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::owning_project_id) / [`set_owning_project_id(Option<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::set_owning_project_id):<br>required: **false**<br><p>The identifier of the project for the subscription requests.</p><br>
    ///   - [`approver_project_id(impl Into<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::approver_project_id) / [`set_approver_project_id(Option<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::set_approver_project_id):<br>required: **false**<br><p>The identifier of the subscription request approver's project.</p><br>
    ///   - [`sort_by(SortKey)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::sort_by) / [`set_sort_by(Option<SortKey>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::set_sort_by):<br>required: **false**<br><p>Specifies the way to sort the results of this action.</p><br>
    ///   - [`sort_order(SortOrder)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::set_sort_order):<br>required: **false**<br><p>Specifies the sort order for the results of this action.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of subscription requests to return in a single call to <code>ListSubscriptionRequests</code>. When the number of subscription requests 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>ListSubscriptionRequests</code> to list the next set of subscription requests.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::set_next_token):<br>required: **false**<br><p>When the number of subscription requests 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 requests, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionRequests</code> to list the next set of subscription requests.</p><br>
    /// - On success, responds with [`ListSubscriptionRequestsOutput`](crate::operation::list_subscription_requests::ListSubscriptionRequestsOutput) with field(s):
    ///   - [`items(Vec::<SubscriptionRequestSummary>)`](crate::operation::list_subscription_requests::ListSubscriptionRequestsOutput::items): <p>The results of the <code>ListSubscriptionRequests</code> action.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_subscription_requests::ListSubscriptionRequestsOutput::next_token): <p>When the number of subscription requests 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 requests, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionRequests</code> to list the next set of subscription requests.</p>
    /// - On failure, responds with [`SdkError<ListSubscriptionRequestsError>`](crate::operation::list_subscription_requests::ListSubscriptionRequestsError)
    pub fn list_subscription_requests(&self) -> crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder {
        crate::operation::list_subscription_requests::builders::ListSubscriptionRequestsFluentBuilder::new(self.handle.clone())
    }
}