Struct CreateHarvestJobOutput

#[non_exhaustive]
pub struct CreateHarvestJobOutput {

    pub channel_group_name: String,
    pub channel_name: String,
    pub origin_endpoint_name: String,
    pub destination: Option<Destination>,
    pub harvest_job_name: String,
    pub harvested_manifests: Option<HarvestedManifests>,
    pub description: Option<String>,
    pub schedule_configuration: Option<HarvesterScheduleConfiguration>,
    pub arn: String,
    pub created_at: DateTime,
    pub modified_at: DateTime,
    pub status: HarvestJobStatus,
    pub error_message: Option<String>,
    pub e_tag: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    /* private fields */
}

The response object returned after creating a harvest job.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

channel_group_name: String

The name of the channel group containing the channel from which content is being harvested.

channel_name: String

The name of the channel from which content is being harvested.

origin_endpoint_name: String

The name of the origin endpoint from which content is being harvested.

destination: Option<Destination>

The S3 destination where the harvested content will be placed.

harvest_job_name: String

The name of the created harvest job.

harvested_manifests: Option<HarvestedManifests>

A list of manifests that will be harvested.

description: Option<String>

The description of the harvest job, if provided.

schedule_configuration: Option<HarvesterScheduleConfiguration>

The configuration for when the harvest job will run, including start and end times.

arn: String

The Amazon Resource Name (ARN) of the created harvest job.

created_at: DateTime

The date and time the harvest job was created.

modified_at: DateTime

The date and time the harvest job was last modified.

status: HarvestJobStatus

The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).

error_message: Option<String>

An error message if the harvest job creation failed.

e_tag: Option<String>

The current version of the harvest job. Used for concurrency control.

tags: Option<HashMap<String, String>>

A collection of tags associated with the harvest job.

Implementations

impl CreateHarvestJobOutput

pub fn channel_group_name(&self) -> &str

The name of the channel group containing the channel from which content is being harvested.

pub fn channel_name(&self) -> &str

The name of the channel from which content is being harvested.

pub fn origin_endpoint_name(&self) -> &str

The name of the origin endpoint from which content is being harvested.

pub fn destination(&self) -> Option<&Destination>

The S3 destination where the harvested content will be placed.

pub fn harvest_job_name(&self) -> &str

The name of the created harvest job.

pub fn harvested_manifests(&self) -> Option<&HarvestedManifests>

A list of manifests that will be harvested.

pub fn description(&self) -> Option<&str>

The description of the harvest job, if provided.

pub fn schedule_configuration(&self) -> Option<&HarvesterScheduleConfiguration>

The configuration for when the harvest job will run, including start and end times.

pub fn arn(&self) -> &str

The Amazon Resource Name (ARN) of the created harvest job.

pub fn created_at(&self) -> &DateTime

The date and time the harvest job was created.

pub fn modified_at(&self) -> &DateTime

The date and time the harvest job was last modified.

pub fn status(&self) -> &HarvestJobStatus

The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).

pub fn error_message(&self) -> Option<&str>

An error message if the harvest job creation failed.

pub fn e_tag(&self) -> Option<&str>

The current version of the harvest job. Used for concurrency control.

pub fn tags(&self) -> Option<&HashMap<String, String>>

A collection of tags associated with the harvest job.

impl CreateHarvestJobOutput

pub fn builder() -> CreateHarvestJobOutputBuilder

Creates a new builder-style object to manufacture CreateHarvestJobOutput.

Trait Implementations

impl Clone for CreateHarvestJobOutput

fn clone(&self) -> CreateHarvestJobOutput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateHarvestJobOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateHarvestJobOutput

fn eq(&self, other: &CreateHarvestJobOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for CreateHarvestJobOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for CreateHarvestJobOutput