aws_sdk_datapipeline/client/
poll_for_task.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`PollForTask`](crate::operation::poll_for_task::builders::PollForTaskFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`worker_group(impl Into<String>)`](crate::operation::poll_for_task::builders::PollForTaskFluentBuilder::worker_group) / [`set_worker_group(Option<String>)`](crate::operation::poll_for_task::builders::PollForTaskFluentBuilder::set_worker_group):<br>required: **true**<br><p>The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for <code>workerGroup</code> in the call to <code>PollForTask</code>. There are no wildcard values permitted in <code>workerGroup</code>; the string must be an exact, case-sensitive, match.</p><br>
    ///   - [`hostname(impl Into<String>)`](crate::operation::poll_for_task::builders::PollForTaskFluentBuilder::hostname) / [`set_hostname(Option<String>)`](crate::operation::poll_for_task::builders::PollForTaskFluentBuilder::set_hostname):<br>required: **false**<br><p>The public DNS name of the calling task runner.</p><br>
    ///   - [`instance_identity(InstanceIdentity)`](crate::operation::poll_for_task::builders::PollForTaskFluentBuilder::instance_identity) / [`set_instance_identity(Option<InstanceIdentity>)`](crate::operation::poll_for_task::builders::PollForTaskFluentBuilder::set_instance_identity):<br>required: **false**<br><p>Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using <code>http://169.254.169.254/latest/meta-data/instance-id</code>. For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.</p><br>
    /// - On success, responds with [`PollForTaskOutput`](crate::operation::poll_for_task::PollForTaskOutput) with field(s):
    ///   - [`task_object(Option<TaskObject>)`](crate::operation::poll_for_task::PollForTaskOutput::task_object): <p>The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is <code>taskId</code>, which contains an identifier for the task being assigned. The calling task runner uses <code>taskId</code> in subsequent calls to <code>ReportTaskProgress</code> and <code>SetTaskStatus</code>.</p>
    /// - On failure, responds with [`SdkError<PollForTaskError>`](crate::operation::poll_for_task::PollForTaskError)
    pub fn poll_for_task(&self) -> crate::operation::poll_for_task::builders::PollForTaskFluentBuilder {
        crate::operation::poll_for_task::builders::PollForTaskFluentBuilder::new(self.handle.clone())
    }
}