Skip to content

PollForTaskInput

Source code in docs_src/capo_data_pipeline/types/poll_for_task_input.py
class PollForTaskInput(TypedDict, closed=True):
    worker_group: "capo_data_pipeline.types.string.string"
    """<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>"""
    hostname: NotRequired["capo_data_pipeline.types.id.id"]
    """<p>The public DNS name of the calling task runner.</p>"""
    instance_identity: NotRequired[
        "capo_data_pipeline.types.instance_identity.InstanceIdentity"
    ]
    """<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>"""

hostname instance-attribute

hostname: NotRequired[id]

The public DNS name of the calling task runner.

instance_identity instance-attribute

instance_identity: NotRequired[InstanceIdentity]

Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. 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.

worker_group instance-attribute

worker_group: string

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 workerGroup in the call to PollForTask. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.