aws_sdk_datazone/client/
list_subscription_targets.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 [`ListSubscriptionTargets`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_identifier(impl Into<String>)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::domain_identifier) / [`set_domain_identifier(Option<String>)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::set_domain_identifier):<br>required: **true**<br><p>The identifier of the Amazon DataZone domain where you want to list subscription targets.</p><br>
    ///   - [`environment_identifier(impl Into<String>)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::environment_identifier) / [`set_environment_identifier(Option<String>)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::set_environment_identifier):<br>required: **true**<br><p>The identifier of the environment where you want to list subscription targets.</p><br>
    ///   - [`sort_by(SortKey)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::sort_by) / [`set_sort_by(Option<SortKey>)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::set_sort_by):<br>required: **false**<br><p>Specifies the way in which the results of this action are to be sorted.</p><br>
    ///   - [`sort_order(SortOrder)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::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_targets::builders::ListSubscriptionTargetsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of subscription targets to return in a single call to <code>ListSubscriptionTargets</code>. When the number of subscription targets 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>ListSubscriptionTargets</code> to list the next set of subscription targets.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::set_next_token):<br>required: **false**<br><p>When the number of subscription targets 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 targets, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionTargets</code> to list the next set of subscription targets.</p><br>
    /// - On success, responds with [`ListSubscriptionTargetsOutput`](crate::operation::list_subscription_targets::ListSubscriptionTargetsOutput) with field(s):
    ///   - [`items(Vec::<SubscriptionTargetSummary>)`](crate::operation::list_subscription_targets::ListSubscriptionTargetsOutput::items): <p>The results of the <code>ListSubscriptionTargets</code> action.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_subscription_targets::ListSubscriptionTargetsOutput::next_token): <p>When the number of subscription targets 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 targets, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListSubscriptionTargets</code> to list the next set of subscription targets.</p>
    /// - On failure, responds with [`SdkError<ListSubscriptionTargetsError>`](crate::operation::list_subscription_targets::ListSubscriptionTargetsError)
    pub fn list_subscription_targets(&self) -> crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder {
        crate::operation::list_subscription_targets::builders::ListSubscriptionTargetsFluentBuilder::new(self.handle.clone())
    }
}