aws_sdk_mediapackagev2/client/
cancel_harvest_job.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CancelHarvestJob`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`channel_group_name(impl Into<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::channel_group_name) / [`set_channel_group_name(Option<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::set_channel_group_name):<br>required: **true**<br><p>The name of the channel group containing the channel from which the harvest job is running.</p><br>
    ///   - [`channel_name(impl Into<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::channel_name) / [`set_channel_name(Option<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::set_channel_name):<br>required: **true**<br><p>The name of the channel from which the harvest job is running.</p><br>
    ///   - [`origin_endpoint_name(impl Into<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::origin_endpoint_name) / [`set_origin_endpoint_name(Option<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::set_origin_endpoint_name):<br>required: **true**<br><p>The name of the origin endpoint that the harvest job is harvesting from. This cannot be changed after the harvest job is submitted.</p><br>
    ///   - [`harvest_job_name(impl Into<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::harvest_job_name) / [`set_harvest_job_name(Option<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::set_harvest_job_name):<br>required: **true**<br><p>The name of the harvest job to cancel. This name must be unique within the channel and cannot be changed after the harvest job is submitted.</p><br>
    ///   - [`e_tag(impl Into<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::e_tag) / [`set_e_tag(Option<String>)`](crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::set_e_tag):<br>required: **false**<br><p>The current Entity Tag (ETag) associated with the harvest job. Used for concurrency control.</p><br>
    /// - On success, responds with [`CancelHarvestJobOutput`](crate::operation::cancel_harvest_job::CancelHarvestJobOutput)
    /// - On failure, responds with [`SdkError<CancelHarvestJobError>`](crate::operation::cancel_harvest_job::CancelHarvestJobError)
    pub fn cancel_harvest_job(&self) -> crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder {
        crate::operation::cancel_harvest_job::builders::CancelHarvestJobFluentBuilder::new(self.handle.clone())
    }
}