1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
/// Constructs a fluent builder for the [`DescribeHarvestJob`](crate::operation::describe_harvest_job::builders::DescribeHarvestJobFluentBuilder) operation.
///
/// - The fluent builder is configurable:
/// - [`id(impl Into<String>)`](crate::operation::describe_harvest_job::builders::DescribeHarvestJobFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::describe_harvest_job::builders::DescribeHarvestJobFluentBuilder::set_id): The ID of the HarvestJob.
/// - On success, responds with [`DescribeHarvestJobOutput`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput) with field(s):
/// - [`arn(Option<String>)`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput::arn): The Amazon Resource Name (ARN) assigned to the HarvestJob.
/// - [`channel_id(Option<String>)`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput::channel_id): The ID of the Channel that the HarvestJob will harvest from.
/// - [`created_at(Option<String>)`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput::created_at): The time the HarvestJob was submitted
/// - [`end_time(Option<String>)`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput::end_time): The end of the time-window which will be harvested.
/// - [`id(Option<String>)`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput::id): The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
/// - [`origin_endpoint_id(Option<String>)`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput::origin_endpoint_id): The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
/// - [`s3_destination(Option<S3Destination>)`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput::s3_destination): Configuration parameters for where in an S3 bucket to place the harvested content
/// - [`start_time(Option<String>)`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput::start_time): The start of the time-window which will be harvested.
/// - [`status(Option<Status>)`](crate::operation::describe_harvest_job::DescribeHarvestJobOutput::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.
/// - On failure, responds with [`SdkError<DescribeHarvestJobError>`](crate::operation::describe_harvest_job::DescribeHarvestJobError)
pub fn describe_harvest_job(
&self,
) -> crate::operation::describe_harvest_job::builders::DescribeHarvestJobFluentBuilder {
crate::operation::describe_harvest_job::builders::DescribeHarvestJobFluentBuilder::new(
self.handle.clone(),
)
}
}