aws_sdk_mediapackagev2/client/
list_harvest_jobs.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 [`ListHarvestJobs`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`channel_group_name(impl Into<String>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::channel_group_name) / [`set_channel_group_name(Option<String>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::set_channel_group_name):<br>required: **true**<br><p>The name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned.</p><br>
8    ///   - [`channel_name(impl Into<String>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::set_channel_name):<br>required: **false**<br><p>The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned.</p><br>
9    ///   - [`origin_endpoint_name(impl Into<String>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::origin_endpoint_name) / [`set_origin_endpoint_name(Option<String>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::set_origin_endpoint_name):<br>required: **false**<br><p>The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned.</p><br>
10    ///   - [`status(HarvestJobStatus)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::status) / [`set_status(Option<HarvestJobStatus>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::set_status):<br>required: **false**<br><p>The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of harvest jobs to return in a single request. If not specified, a default value will be used.</p><br>
12    ///   - [`next_token(impl Into<String>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token used for pagination. Provide this value in subsequent requests to retrieve the next set of results.</p><br>
13    /// - On success, responds with [`ListHarvestJobsOutput`](crate::operation::list_harvest_jobs::ListHarvestJobsOutput) with field(s):
14    ///   - [`items(Option<Vec::<HarvestJob>>)`](crate::operation::list_harvest_jobs::ListHarvestJobsOutput::items): <p>An array of harvest job objects that match the specified criteria.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::list_harvest_jobs::ListHarvestJobsOutput::next_token): <p>A token used for pagination. Include this value in subsequent requests to retrieve the next set of results. If null, there are no more results to retrieve.</p>
16    /// - On failure, responds with [`SdkError<ListHarvestJobsError>`](crate::operation::list_harvest_jobs::ListHarvestJobsError)
17    pub fn list_harvest_jobs(&self) -> crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder {
18        crate::operation::list_harvest_jobs::builders::ListHarvestJobsFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_mediapackagev2/client/list_harvest_jobs.rs

aws_sdk_mediapackagev2/client/
list_harvest_jobs.rs
