aws_sdk_mediaconnect/client/list_entitlements.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ListEntitlements`](crate::operation::list_entitlements::builders::ListEntitlementsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_entitlements::builders::ListEntitlementsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`max_results(i32)`](crate::operation::list_entitlements::builders::ListEntitlementsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_entitlements::builders::ListEntitlementsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return per API request.</p> <p>For example, you submit a <code>ListEntitlements</code> request with set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)</p> <p>The service might return fewer results than the <code>MaxResults</code> value. If <code>MaxResults</code> is not included in the request, the service defaults to pagination with a maximum of 20 results per page.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_entitlements::builders::ListEntitlementsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_entitlements::builders::ListEntitlementsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token that identifies the batch of results that you want to see.</p> <p>For example, you submit a <code>ListEntitlements</code> request with <code>MaxResults</code> set at 5. The service returns the first batch of results (up to 5) and a <code>NextToken</code> value. To see the next batch of results, you can submit the <code>ListEntitlements</code> request a second time and specify the <code>NextToken</code> value.</p><br>
9 /// - On success, responds with [`ListEntitlementsOutput`](crate::operation::list_entitlements::ListEntitlementsOutput) with field(s):
10 /// - [`entitlements(Option<Vec::<ListedEntitlement>>)`](crate::operation::list_entitlements::ListEntitlementsOutput::entitlements): <p>A list of entitlements that have been granted to you from other Amazon Web Services accounts.</p>
11 /// - [`next_token(Option<String>)`](crate::operation::list_entitlements::ListEntitlementsOutput::next_token): <p>The token that identifies the batch of results that you want to see.</p> <p>For example, you submit a ListEntitlements request with <code>MaxResults</code> set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the <code>ListEntitlements</code> request a second time and specify the <code>NextToken</code> value.</p>
12 /// - On failure, responds with [`SdkError<ListEntitlementsError>`](crate::operation::list_entitlements::ListEntitlementsError)
13 pub fn list_entitlements(&self) -> crate::operation::list_entitlements::builders::ListEntitlementsFluentBuilder {
14 crate::operation::list_entitlements::builders::ListEntitlementsFluentBuilder::new(self.handle.clone())
15 }
16}