aws_sdk_mediapackagev2/client/
create_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 [`CreateHarvestJob`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`channel_group_name(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::channel_group_name) / [`set_channel_group_name(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_channel_group_name):<br>required: **true**<br><p>The name of the channel group containing the channel from which to harvest content.</p><br>
7    ///   - [`channel_name(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_channel_name):<br>required: **true**<br><p>The name of the channel from which to harvest content.</p><br>
8    ///   - [`origin_endpoint_name(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::origin_endpoint_name) / [`set_origin_endpoint_name(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_origin_endpoint_name):<br>required: **true**<br><p>The name of the origin endpoint from which to harvest content.</p><br>
9    ///   - [`description(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_description):<br>required: **false**<br><p>An optional description for the harvest job.</p><br>
10    ///   - [`harvested_manifests(HarvestedManifests)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::harvested_manifests) / [`set_harvested_manifests(Option<HarvestedManifests>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_harvested_manifests):<br>required: **true**<br><p>A list of manifests to be harvested.</p><br>
11    ///   - [`schedule_configuration(HarvesterScheduleConfiguration)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::schedule_configuration) / [`set_schedule_configuration(Option<HarvesterScheduleConfiguration>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_schedule_configuration):<br>required: **true**<br><p>The configuration for when the harvest job should run, including start and end times.</p><br>
12    ///   - [`destination(Destination)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::destination) / [`set_destination(Option<Destination>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_destination):<br>required: **true**<br><p>The S3 destination where the harvested content will be placed.</p><br>
13    ///   - [`client_token(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p><br>
14    ///   - [`harvest_job_name(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::harvest_job_name) / [`set_harvest_job_name(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_harvest_job_name):<br>required: **false**<br><p>A name for the harvest job. This name must be unique within the channel.</p><br>
15    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_tags):<br>required: **false**<br><p>A collection of tags associated with the harvest job.</p><br>
16    /// - On success, responds with [`CreateHarvestJobOutput`](crate::operation::create_harvest_job::CreateHarvestJobOutput) with field(s):
17    ///   - [`channel_group_name(String)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::channel_group_name): <p>The name of the channel group containing the channel from which content is being harvested.</p>
18    ///   - [`channel_name(String)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::channel_name): <p>The name of the channel from which content is being harvested.</p>
19    ///   - [`origin_endpoint_name(String)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::origin_endpoint_name): <p>The name of the origin endpoint from which content is being harvested.</p>
20    ///   - [`destination(Option<Destination>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::destination): <p>The S3 destination where the harvested content will be placed.</p>
21    ///   - [`harvest_job_name(String)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::harvest_job_name): <p>The name of the created harvest job.</p>
22    ///   - [`harvested_manifests(Option<HarvestedManifests>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::harvested_manifests): <p>A list of manifests that will be harvested.</p>
23    ///   - [`description(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::description): <p>The description of the harvest job, if provided.</p>
24    ///   - [`schedule_configuration(Option<HarvesterScheduleConfiguration>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::schedule_configuration): <p>The configuration for when the harvest job will run, including start and end times.</p>
25    ///   - [`arn(String)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::arn): <p>The Amazon Resource Name (ARN) of the created harvest job.</p>
26    ///   - [`created_at(DateTime)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::created_at): <p>The date and time the harvest job was created.</p>
27    ///   - [`modified_at(DateTime)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::modified_at): <p>The date and time the harvest job was last modified.</p>
28    ///   - [`status(HarvestJobStatus)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::status): <p>The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).</p>
29    ///   - [`error_message(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::error_message): <p>An error message if the harvest job creation failed.</p>
30    ///   - [`e_tag(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::e_tag): <p>The current version of the harvest job. Used for concurrency control.</p>
31    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::tags): <p>A collection of tags associated with the harvest job.</p>
32    /// - On failure, responds with [`SdkError<CreateHarvestJobError>`](crate::operation::create_harvest_job::CreateHarvestJobError)
33    pub fn create_harvest_job(&self) -> crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder {
34        crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::new(self.handle.clone())
35    }
36}
aws_sdk_mediapackagev2/client/create_harvest_job.rs

aws_sdk_mediapackagev2/client/
create_harvest_job.rs
