aws_sdk_sfn/client/

get_activity_task.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetActivityTask`](crate::operation::get_activity_task::builders::GetActivityTaskFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`activity_arn(impl Into<String>)`](crate::operation::get_activity_task::builders::GetActivityTaskFluentBuilder::activity_arn) / [`set_activity_arn(Option<String>)`](crate::operation::get_activity_task::builders::GetActivityTaskFluentBuilder::set_activity_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using <code>CreateActivity</code>.)</p><br>
    ///   - [`worker_name(impl Into<String>)`](crate::operation::get_activity_task::builders::GetActivityTaskFluentBuilder::worker_name) / [`set_worker_name(Option<String>)`](crate::operation::get_activity_task::builders::GetActivityTaskFluentBuilder::set_worker_name):<br>required: **false**<br><p>You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.</p><br>
    /// - On success, responds with [`GetActivityTaskOutput`](crate::operation::get_activity_task::GetActivityTaskOutput) with field(s):
    ///   - [`task_token(Option<String>)`](crate::operation::get_activity_task::GetActivityTaskOutput::task_token): <p>A token that identifies the scheduled task. This token must be copied and included in subsequent calls to <code>SendTaskHeartbeat</code>, <code>SendTaskSuccess</code> or <code>SendTaskFailure</code> in order to report the progress or completion of the task.</p>
    ///   - [`input(Option<String>)`](crate::operation::get_activity_task::GetActivityTaskOutput::input): <p>The string that contains the JSON input data for the task. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
    /// - On failure, responds with [`SdkError<GetActivityTaskError>`](crate::operation::get_activity_task::GetActivityTaskError)
    pub fn get_activity_task(&self) -> crate::operation::get_activity_task::builders::GetActivityTaskFluentBuilder {
        crate::operation::get_activity_task::builders::GetActivityTaskFluentBuilder::new(self.handle.clone())
    }
}