Skip to content

Send Project Session Action

gluedatabrew_send_project_session_action R Documentation

Performs a recipe step within an interactive DataBrew session that's currently open

Description

Performs a recipe step within an interactive DataBrew session that's currently open.

Usage

gluedatabrew_send_project_session_action(Preview, Name, RecipeStep,
  StepIndex, ClientSessionId, ViewFrame)

Arguments

Preview

If true, the result of the recipe step will be returned, but not applied.

Name

[required] The name of the project to apply the action to.

RecipeStep

Represents a single step from a DataBrew recipe to be performed.

StepIndex

The index from which to preview a step. This index is used to preview the result of steps that have already been applied, so that the resulting view frame is from earlier in the view frame stack.

ClientSessionId

A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.

ViewFrame

Represents the data being transformed during an action.

Value

A list with the following syntax:

list(
  Result = "string",
  Name = "string",
  ActionId = 123
)

Request syntax

svc$send_project_session_action(
  Preview = TRUE|FALSE,
  Name = "string",
  RecipeStep = list(
    Action = list(
      Operation = "string",
      Parameters = list(
        "string"
      )
    ),
    ConditionExpressions = list(
      list(
        Condition = "string",
        Value = "string",
        TargetColumn = "string"
      )
    )
  ),
  StepIndex = 123,
  ClientSessionId = "string",
  ViewFrame = list(
    StartColumnIndex = 123,
    ColumnRange = 123,
    HiddenColumns = list(
      "string"
    ),
    StartRowIndex = 123,
    RowRange = 123,
    Analytics = "ENABLE"|"DISABLE"
  )
)