aws_sdk_mediapackage/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    ///   - [`end_time(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::end_time) / [`set_end_time(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_end_time):<br>required: **true**<br>The end of the time-window which will be harvested<br>
7    ///   - [`id(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_id):<br>required: **true**<br>The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted<br>
8    ///   - [`origin_endpoint_id(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::origin_endpoint_id) / [`set_origin_endpoint_id(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_origin_endpoint_id):<br>required: **true**<br>The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.<br>
9    ///   - [`s3_destination(S3Destination)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::s3_destination) / [`set_s3_destination(Option<S3Destination>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_s3_destination):<br>required: **true**<br>Configuration parameters for where in an S3 bucket to place the harvested content<br>
10    ///   - [`start_time(impl Into<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::start_time) / [`set_start_time(Option<String>)`](crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::set_start_time):<br>required: **true**<br>The start of the time-window which will be harvested<br>
11    /// - On success, responds with [`CreateHarvestJobOutput`](crate::operation::create_harvest_job::CreateHarvestJobOutput) with field(s):
12    ///   - [`arn(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::arn): The Amazon Resource Name (ARN) assigned to the HarvestJob.
13    ///   - [`channel_id(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::channel_id): The ID of the Channel that the HarvestJob will harvest from.
14    ///   - [`created_at(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::created_at): The date and time the HarvestJob was submitted.
15    ///   - [`end_time(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::end_time): The end of the time-window which will be harvested.
16    ///   - [`id(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::id): The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
17    ///   - [`origin_endpoint_id(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::origin_endpoint_id): The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
18    ///   - [`s3_destination(Option<S3Destination>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::s3_destination): Configuration parameters for where in an S3 bucket to place the harvested content
19    ///   - [`start_time(Option<String>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::start_time): The start of the time-window which will be harvested.
20    ///   - [`status(Option<Status>)`](crate::operation::create_harvest_job::CreateHarvestJobOutput::status): The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.
21    /// - On failure, responds with [`SdkError<CreateHarvestJobError>`](crate::operation::create_harvest_job::CreateHarvestJobError)
22    pub fn create_harvest_job(&self) -> crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder {
23        crate::operation::create_harvest_job::builders::CreateHarvestJobFluentBuilder::new(self.handle.clone())
24    }
25}