R/steps_compute.R
In DyfanJones/aws-step-functions-data-science-sdk-r: R SDK for `AWS Stepfunctions`
# NOTE: This code has been modified from AWS Stepfunctions Python:
# https://github.com/aws/aws-step-functions-data-science-sdk-python/blob/main/src/stepfunctions/steps/compute.py
#' @include steps_fields.R
#' @include steps_states.R
#' @include steps_integrate_resources.R
#' @include utils.R
#' @import R6
LAMBDA_SERVICE_NAME = "lambda"
GLUE_SERVICE_NAME = "glue"
ATHENA_SERVICE_NAME = "athena"
DATABREW_SERVICE_NAME = "databrew"
ECS_SERVICE_NAME = "ecs"
BATCH_SERVICE_NAME = "batch"
LambdaApi = Enum(
Invoke = "invoke"
)
GlueApi = Enum(
StartJobRun = "startJobRun"
)
DataBrewApi = Enum(
StartJobRun = "startJobRun"
)
AthenaApi = Enum(
StartQueryExecution = "startQueryExecution",
StopQueryExecution = "stopQueryExecution",
GetQueryExecution = "getQueryExecution",
GetQueryResults = "getQueryResults"
)
EcsApi = Enum(
RunTask = "runTask"
)
BatchApi = Enum(
SubmitJob = "submitJob"
)
#' @title LambdaStep class
#' @description Creates a Task state to invoke an AWS Lambda function.
#' See Invoke Lambda with Step Functions
#' \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-lambda.html}
#' for more details.
#' @export
LambdaStep = R6Class("LambdaStep",
inherit = Task,
public = list(
#' @description Initialize LambdaStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_callback (bool, optional): Boolean value set to `True` if the
#' Task state should wait for callback to resume the operation. (default: False)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_callback=FALSE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_callback)
kwargs[[Field$Resource]] = get_service_integration_arn(
LAMBDA_SERVICE_NAME,
LambdaApi$Invoke,
IntegrationPattern$WaitForTaskToken)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
LAMBDA_SERVICE_NAME, LambdaApi$Invoke)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title GlueStartJobRunStep Class
#' @description Creates a Task state to run an AWS Glue job. See Manage AWS Glue Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-glue.html}
#' for more details.
#' @export
GlueStartJobRunStep = R6Class("GlueStartJobRunStep",
inherit = Task,
public = list(
#' @description Initialize GlueStartJobRunStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
GLUE_SERVICE_NAME,
GlueApi$StartJobRun,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
GLUE_SERVICE_NAME,
GlueApi$StartJobRun)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title DataBrewStartJobRunStep Class
#' @description Creates a Task state to run an AWS Glue job. See Manage AWS Glue DataBrew Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-databrew.html}
#' for more details.
#' @export
DataBrewStartJobRunStep = R6Class("DataBrewStartJobRunStep",
inherit = Task,
public = list(
#' @description Initialize DataBrewStartJobRunStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
DATABREW_SERVICE_NAME,
DataBrewApi$StartJobRun,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
DATABREW_SERVICE_NAME,
DataBrewApi$StartJobRun)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title AthenaStartQueryExecutionStep Class
#' @description Creates a Task state to run an AWS Athena job. See Manage AWS Athena Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html}
#' for more details.
#' @export
AthenaStartQueryExecutionStep = R6Class("AthenaStartQueryExecutionStep",
inherit = Task,
public = list(
#' @description Initialize AthenaStartQueryExecutionStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$StartQueryExecution,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$StartQueryExecution)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title AthenaStopQueryExecutionStep Class
#' @description Creates a Task state to run an AWS Athena job. See Manage AWS Athena Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html}
#' for more details.
#' @export
AthenaStopQueryExecutionStep = R6Class("AthenaStopQueryExecutionStep",
inherit = Task,
public = list(
#' @description Initialize AthenaStopQueryExecutionStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = c(as.list(environment()), list(...))
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$StopQueryExecution)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title AthenaGetQueryExecutionStep Class
#' @description Creates a Task state to run an AWS Athena job. See Manage AWS Athena Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html}
#' for more details.
#' @export
AthenaGetQueryExecutionStep = R6Class("AthenaGetQueryExecutionStep",
inherit = Task,
public = list(
#' @description Initialize AthenaGetQueryExecutionStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = c(as.list(environment()), list(...))
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$GetQueryExecution)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title AthenaGetQueryResultsStep Class
#' @description Creates a Task state to run an AWS Athena job. See Manage AWS Athena Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html}
#' for more details.
#' @export
AthenaGetQueryResultsStep = R6Class("AthenaGetQueryResultsStep",
inherit = Task,
public = list(
#' @description Initialize AthenaGetQueryResultsStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = c(as.list(environment()), list(...))
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$GetQueryResults)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title BatchSubmitJobStep Class
#' @description Creates a Task State to start an AWS Batch job. See `Manage AWS Batch`
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-batch.html}
#' for more details.
#' @export
BatchSubmitJobStep = R6Class("BatchSubmitJobStep",
inherit = Task,
public = list(
#' @description Initialize BatchSubmitJobStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
BATCH_SERVICE_NAME,
BatchApi$SubmitJob,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
BATCH_SERVICE_NAME,
BatchApi$SubmitJob)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title EcsRunTaskStep class
#' @description Creates a Task State to run Amazon ECS or Fargate Tasks. See `Manage Amazon ECS`
#' or Fargate Tasks with Step Functions
#' \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-ecs.html}
#' for more details.
#' @export
EcsRunTaskStep = R6Class("EcsRunTaskStep",
inherit = Task,
public = list(
#' @description Initialize EcsRunTaskStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
ECS_SERVICE_NAME,
EcsApi$RunTask,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
ECS_SERVICE_NAME,
EcsApi$RunTask)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
DyfanJones/aws-step-functions-data-science-sdk-r documentation built on Dec. 17, 2021, 5:31 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
# NOTE: This code has been modified from AWS Stepfunctions Python:
# https://github.com/aws/aws-step-functions-data-science-sdk-python/blob/main/src/stepfunctions/steps/compute.py
#' @include steps_fields.R
#' @include steps_states.R
#' @include steps_integrate_resources.R
#' @include utils.R
#' @import R6
LAMBDA_SERVICE_NAME = "lambda"
GLUE_SERVICE_NAME = "glue"
ATHENA_SERVICE_NAME = "athena"
DATABREW_SERVICE_NAME = "databrew"
ECS_SERVICE_NAME = "ecs"
BATCH_SERVICE_NAME = "batch"
LambdaApi = Enum(
Invoke = "invoke"
)
GlueApi = Enum(
StartJobRun = "startJobRun"
)
DataBrewApi = Enum(
StartJobRun = "startJobRun"
)
AthenaApi = Enum(
StartQueryExecution = "startQueryExecution",
StopQueryExecution = "stopQueryExecution",
GetQueryExecution = "getQueryExecution",
GetQueryResults = "getQueryResults"
)
EcsApi = Enum(
RunTask = "runTask"
)
BatchApi = Enum(
SubmitJob = "submitJob"
)
#' @title LambdaStep class
#' @description Creates a Task state to invoke an AWS Lambda function.
#' See Invoke Lambda with Step Functions
#' \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-lambda.html}
#' for more details.
#' @export
LambdaStep = R6Class("LambdaStep",
inherit = Task,
public = list(
#' @description Initialize LambdaStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_callback (bool, optional): Boolean value set to `True` if the
#' Task state should wait for callback to resume the operation. (default: False)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_callback=FALSE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_callback)
kwargs[[Field$Resource]] = get_service_integration_arn(
LAMBDA_SERVICE_NAME,
LambdaApi$Invoke,
IntegrationPattern$WaitForTaskToken)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
LAMBDA_SERVICE_NAME, LambdaApi$Invoke)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title GlueStartJobRunStep Class
#' @description Creates a Task state to run an AWS Glue job. See Manage AWS Glue Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-glue.html}
#' for more details.
#' @export
GlueStartJobRunStep = R6Class("GlueStartJobRunStep",
inherit = Task,
public = list(
#' @description Initialize GlueStartJobRunStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
GLUE_SERVICE_NAME,
GlueApi$StartJobRun,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
GLUE_SERVICE_NAME,
GlueApi$StartJobRun)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title DataBrewStartJobRunStep Class
#' @description Creates a Task state to run an AWS Glue job. See Manage AWS Glue DataBrew Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-databrew.html}
#' for more details.
#' @export
DataBrewStartJobRunStep = R6Class("DataBrewStartJobRunStep",
inherit = Task,
public = list(
#' @description Initialize DataBrewStartJobRunStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
DATABREW_SERVICE_NAME,
DataBrewApi$StartJobRun,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
DATABREW_SERVICE_NAME,
DataBrewApi$StartJobRun)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title AthenaStartQueryExecutionStep Class
#' @description Creates a Task state to run an AWS Athena job. See Manage AWS Athena Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html}
#' for more details.
#' @export
AthenaStartQueryExecutionStep = R6Class("AthenaStartQueryExecutionStep",
inherit = Task,
public = list(
#' @description Initialize AthenaStartQueryExecutionStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$StartQueryExecution,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$StartQueryExecution)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title AthenaStopQueryExecutionStep Class
#' @description Creates a Task state to run an AWS Athena job. See Manage AWS Athena Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html}
#' for more details.
#' @export
AthenaStopQueryExecutionStep = R6Class("AthenaStopQueryExecutionStep",
inherit = Task,
public = list(
#' @description Initialize AthenaStopQueryExecutionStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = c(as.list(environment()), list(...))
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$StopQueryExecution)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title AthenaGetQueryExecutionStep Class
#' @description Creates a Task state to run an AWS Athena job. See Manage AWS Athena Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html}
#' for more details.
#' @export
AthenaGetQueryExecutionStep = R6Class("AthenaGetQueryExecutionStep",
inherit = Task,
public = list(
#' @description Initialize AthenaGetQueryExecutionStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = c(as.list(environment()), list(...))
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$GetQueryExecution)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title AthenaGetQueryResultsStep Class
#' @description Creates a Task state to run an AWS Athena job. See Manage AWS Athena Jobs
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-athena.html}
#' for more details.
#' @export
AthenaGetQueryResultsStep = R6Class("AthenaGetQueryResultsStep",
inherit = Task,
public = list(
#' @description Initialize AthenaGetQueryResultsStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = c(as.list(environment()), list(...))
kwargs[[Field$Resource]] = get_service_integration_arn(
ATHENA_SERVICE_NAME,
AthenaApi$GetQueryResults)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title BatchSubmitJobStep Class
#' @description Creates a Task State to start an AWS Batch job. See `Manage AWS Batch`
#' with Step Functions \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-batch.html}
#' for more details.
#' @export
BatchSubmitJobStep = R6Class("BatchSubmitJobStep",
inherit = Task,
public = list(
#' @description Initialize BatchSubmitJobStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
BATCH_SERVICE_NAME,
BatchApi$SubmitJob,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
BATCH_SERVICE_NAME,
BatchApi$SubmitJob)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
#' @title EcsRunTaskStep class
#' @description Creates a Task State to run Amazon ECS or Fargate Tasks. See `Manage Amazon ECS`
#' or Fargate Tasks with Step Functions
#' \url{https://docs.aws.amazon.com/step-functions/latest/dg/connect-ecs.html}
#' for more details.
#' @export
EcsRunTaskStep = R6Class("EcsRunTaskStep",
inherit = Task,
public = list(
#' @description Initialize EcsRunTaskStep Task class
#' @param state_id (str): State name whose length **must be** less than or
#' equal to 128 unicode characters. State names **must be** unique
#' within the scope of the whole state machine.
#' @param wait_for_completion (bool, optional): Boolean value set to `True` if
#' the Task state should wait for the glue job to complete before proceeding
#' to the next step in the workflow. Set to `False` if the Task state should
#' submit the glue job and proceed to the next step. (default: True)
#' @param timeout_seconds (int, optional): Positive integer specifying timeout for the
#' state in seconds. If the state runs longer than the specified timeout,
#' then the interpreter fails the state with a `States.Timeout` Error Name. (default: 60)
#' @param timeout_seconds_path (str, optional): Path specifying the state's timeout
#' value in seconds from the state input. When resolved, the path must select
#' a field whose value is a positive integer.
#' @param heartbeat_seconds (int, optional): Positive integer specifying heartbeat
#' timeout for the state in seconds. This value should be lower than
#' the one specified for `timeout_seconds`. If more time than the specified
#' heartbeat elapses between heartbeats from the task, then the interpreter
#' fails the state with a `States.Timeout` Error Name.
#' @param heartbeat_seconds_path (str, optional): Path specifying the state's
#' heartbeat value in seconds from the state input. When resolved,
#' the path must select a field whose value is a positive integer.
#' @param comment (str, optional): Human-readable comment or description. (default: None)
#' @param input_path (str, optional): Path applied to the state’s raw input to
#' select some or all of it; that selection is used by the state. (default: '$')
#' @param parameters (list, optional): The value of this field becomes the effective
#' input for the state.
#' @param result_path (str, optional): Path specifying the raw input’s combination
#' with or replacement by the state’s result. (default: '$')
#' @param output_path (str, optional): Path applied to the state’s output after
#' the application of `result_path`, producing the effective output
#' which serves as the raw input for the next state. (default: '$')
#' @param ... : Extra Fields passed to Task class
initialize = function(state_id,
wait_for_completion=TRUE,
timeout_seconds=NULL,
timeout_seconds_path=NULL,
heartbeat_seconds=NULL,
heartbeat_seconds_path=NULL,
comment=NULL,
input_path=NULL,
parameters=NULL,
result_path=NULL,
output_path=NULL,
...){
kwargs = list(
state_id=state_id,
timeout_seconds=timeout_seconds,
timeout_seconds_path=timeout_seconds_path,
heartbeat_seconds=heartbeat_seconds,
heartbeat_seconds_path=heartbeat_seconds_path,
comment=comment,
input_path=input_path,
parameters=parameters,
result_path=result_path,
output_path=output_path,
...)
if (wait_for_completion)
kwargs[[Field$Resource]] = get_service_integration_arn(
ECS_SERVICE_NAME,
EcsApi$RunTask,
IntegrationPattern$WaitForCompletion)
else
kwargs[[Field$Resource]] = get_service_integration_arn(
ECS_SERVICE_NAME,
EcsApi$RunTask)
do.call(super$initialize, kwargs)
}
),
lock_objects=F
)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.