Module Values.GetActivityTaskOutputSource

Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. This API action isn't logged in CloudTrail. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

Sourcetype nonrec t = {
  1. taskToken : TaskToken.t option;
    (*

    A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.

    *)
  2. input : SensitiveDataJobInput.t option;
    (*

    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.

    *)
}
Sourcetype nonrec error = [
  1. | `ActivityDoesNotExist of ActivityDoesNotExist.t
  2. | `ActivityWorkerLimitExceeded of ActivityWorkerLimitExceeded.t
  3. | `InvalidArn of InvalidArn.t
  4. | `KmsAccessDeniedException of KmsAccessDeniedException.t
  5. | `KmsInvalidStateException of KmsInvalidStateException.t
  6. | `KmsThrottlingException of KmsThrottlingException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?taskToken:??? -> ?input:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `ActivityDoesNotExist of ActivityDoesNotExist.t | `ActivityWorkerLimitExceeded of ActivityWorkerLimitExceeded.t | `InvalidArn of InvalidArn.t | `KmsAccessDeniedException of KmsAccessDeniedException.t | `KmsInvalidStateException of KmsInvalidStateException.t | `KmsThrottlingException of KmsThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `ActivityDoesNotExist of ActivityDoesNotExist.t | `ActivityWorkerLimitExceeded of ActivityWorkerLimitExceeded.t | `InvalidArn of InvalidArn.t | `KmsAccessDeniedException of KmsAccessDeniedException.t | `KmsInvalidStateException of KmsInvalidStateException.t | `KmsThrottlingException of KmsThrottlingException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of TaskToken.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t