aws_sdk_mediatailor/client/list_vod_sources.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 [`ListVodSources`](crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`max_results(i32)`](crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> VOD sources, use the value of <code>NextToken</code> in the response to get the next page of results.</p> <p>The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than <code>MaxResults</code> items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the <code>NextToken</code> value from each response until the response no longer includes a <code>NextToken</code> value.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder::set_next_token):<br>required: **false**<br><p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p> <p>For the first <code>ListVodSources</code> request, omit this value. For subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request. Continue making requests until the response no longer includes a <code>NextToken</code> value, which indicates that all results have been retrieved.</p><br>
9 /// - [`source_location_name(impl Into<String>)`](crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder::source_location_name) / [`set_source_location_name(Option<String>)`](crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder::set_source_location_name):<br>required: **true**<br><p>The name of the source location associated with this VOD Source list.</p><br>
10 /// - On success, responds with [`ListVodSourcesOutput`](crate::operation::list_vod_sources::ListVodSourcesOutput) with field(s):
11 /// - [`items(Option<Vec::<VodSource>>)`](crate::operation::list_vod_sources::ListVodSourcesOutput::items): <p>Lists the VOD sources.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_vod_sources::ListVodSourcesOutput::next_token): <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
13 /// - On failure, responds with [`SdkError<ListVodSourcesError>`](crate::operation::list_vod_sources::ListVodSourcesError)
14 pub fn list_vod_sources(&self) -> crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder {
15 crate::operation::list_vod_sources::builders::ListVodSourcesFluentBuilder::new(self.handle.clone())
16 }
17}