aws_sdk_mediapackagev2/client/
get_harvest_job.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 [`GetHarvestJob`](crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`channel_group_name(impl Into<String>)`](crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder::channel_group_name) / [`set_channel_group_name(Option<String>)`](crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder::set_channel_group_name):<br>required: **true**<br><p>The name of the channel group containing the channel associated with the harvest job.</p><br>
7    ///   - [`channel_name(impl Into<String>)`](crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder::set_channel_name):<br>required: **true**<br><p>The name of the channel associated with the harvest job.</p><br>
8    ///   - [`origin_endpoint_name(impl Into<String>)`](crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder::origin_endpoint_name) / [`set_origin_endpoint_name(Option<String>)`](crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder::set_origin_endpoint_name):<br>required: **true**<br><p>The name of the origin endpoint associated with the harvest job.</p><br>
9    ///   - [`harvest_job_name(impl Into<String>)`](crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder::harvest_job_name) / [`set_harvest_job_name(Option<String>)`](crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder::set_harvest_job_name):<br>required: **true**<br><p>The name of the harvest job to retrieve.</p><br>
10    /// - On success, responds with [`GetHarvestJobOutput`](crate::operation::get_harvest_job::GetHarvestJobOutput) with field(s):
11    ///   - [`channel_group_name(String)`](crate::operation::get_harvest_job::GetHarvestJobOutput::channel_group_name): <p>The name of the channel group containing the channel associated with the harvest job.</p>
12    ///   - [`channel_name(String)`](crate::operation::get_harvest_job::GetHarvestJobOutput::channel_name): <p>The name of the channel associated with the harvest job.</p>
13    ///   - [`origin_endpoint_name(String)`](crate::operation::get_harvest_job::GetHarvestJobOutput::origin_endpoint_name): <p>The name of the origin endpoint associated with the harvest job.</p>
14    ///   - [`destination(Option<Destination>)`](crate::operation::get_harvest_job::GetHarvestJobOutput::destination): <p>The S3 destination where the harvested content is being placed.</p>
15    ///   - [`harvest_job_name(String)`](crate::operation::get_harvest_job::GetHarvestJobOutput::harvest_job_name): <p>The name of the harvest job.</p>
16    ///   - [`harvested_manifests(Option<HarvestedManifests>)`](crate::operation::get_harvest_job::GetHarvestJobOutput::harvested_manifests): <p>A list of manifests that are being or have been harvested.</p>
17    ///   - [`description(Option<String>)`](crate::operation::get_harvest_job::GetHarvestJobOutput::description): <p>The description of the harvest job, if provided.</p>
18    ///   - [`schedule_configuration(Option<HarvesterScheduleConfiguration>)`](crate::operation::get_harvest_job::GetHarvestJobOutput::schedule_configuration): <p>The configuration for when the harvest job is scheduled to run, including start and end times.</p>
19    ///   - [`arn(String)`](crate::operation::get_harvest_job::GetHarvestJobOutput::arn): <p>The Amazon Resource Name (ARN) of the harvest job.</p>
20    ///   - [`created_at(DateTime)`](crate::operation::get_harvest_job::GetHarvestJobOutput::created_at): <p>The date and time when the harvest job was created.</p>
21    ///   - [`modified_at(DateTime)`](crate::operation::get_harvest_job::GetHarvestJobOutput::modified_at): <p>The date and time when the harvest job was last modified.</p>
22    ///   - [`status(HarvestJobStatus)`](crate::operation::get_harvest_job::GetHarvestJobOutput::status): <p>The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).</p>
23    ///   - [`error_message(Option<String>)`](crate::operation::get_harvest_job::GetHarvestJobOutput::error_message): <p>An error message if the harvest job encountered any issues.</p>
24    ///   - [`e_tag(Option<String>)`](crate::operation::get_harvest_job::GetHarvestJobOutput::e_tag): <p>The current version of the harvest job. Used for concurrency control.</p>
25    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_harvest_job::GetHarvestJobOutput::tags): <p>A collection of tags associated with the harvest job.</p>
26    /// - On failure, responds with [`SdkError<GetHarvestJobError>`](crate::operation::get_harvest_job::GetHarvestJobError)
27    pub fn get_harvest_job(&self) -> crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder {
28        crate::operation::get_harvest_job::builders::GetHarvestJobFluentBuilder::new(self.handle.clone())
29    }
30}
aws_sdk_mediapackagev2/client/get_harvest_job.rs

aws_sdk_mediapackagev2/client/
get_harvest_job.rs
