Class: Aws::GlueDataBrew::Types::SendProjectSessionActionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb

Overview

Note:

When making an API call, you may pass SendProjectSessionActionRequest data as a hash:

{
  preview: false,
  name: "ProjectName", # required
  recipe_step: {
    action: { # required
      operation: "Operation", # required
      parameters: {
        "ParameterName" => "ParameterValue",
      },
    },
    condition_expressions: [
      {
        condition: "Condition", # required
        value: "ConditionValue",
        target_column: "TargetColumn", # required
      },
    ],
  },
  step_index: 1,
  client_session_id: "ClientSessionId",
  view_frame: {
    start_column_index: 1, # required
    column_range: 1,
    hidden_columns: ["ColumnName"],
    start_row_index: 1,
    row_range: 1,
    analytics: "ENABLE", # accepts ENABLE, DISABLE
  },
}

Constant Summary collapse

SENSITIVE =
[:client_session_id]

Instance Attribute Summary collapse

Instance Attribute Details

#client_session_idString

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

Returns:

  • (String)


4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4561

class SendProjectSessionActionRequest < Struct.new(
  :preview,
  :name,
  :recipe_step,
  :step_index,
  :client_session_id,
  :view_frame)
  SENSITIVE = [:client_session_id]
  include Aws::Structure
end

#nameString

The name of the project to apply the action to.

Returns:

  • (String)


4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4561

class SendProjectSessionActionRequest < Struct.new(
  :preview,
  :name,
  :recipe_step,
  :step_index,
  :client_session_id,
  :view_frame)
  SENSITIVE = [:client_session_id]
  include Aws::Structure
end

#previewBoolean

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

Returns:

  • (Boolean)


4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4561

class SendProjectSessionActionRequest < Struct.new(
  :preview,
  :name,
  :recipe_step,
  :step_index,
  :client_session_id,
  :view_frame)
  SENSITIVE = [:client_session_id]
  include Aws::Structure
end

#recipe_stepTypes::RecipeStep

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

Returns:



4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4561

class SendProjectSessionActionRequest < Struct.new(
  :preview,
  :name,
  :recipe_step,
  :step_index,
  :client_session_id,
  :view_frame)
  SENSITIVE = [:client_session_id]
  include Aws::Structure
end

#step_indexInteger

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.

Returns:

  • (Integer)


4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4561

class SendProjectSessionActionRequest < Struct.new(
  :preview,
  :name,
  :recipe_step,
  :step_index,
  :client_session_id,
  :view_frame)
  SENSITIVE = [:client_session_id]
  include Aws::Structure
end

#view_frameTypes::ViewFrame

Represents the data being transformed during an action.

Returns:



4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
# File 'gems/aws-sdk-gluedatabrew/lib/aws-sdk-gluedatabrew/types.rb', line 4561

class SendProjectSessionActionRequest < Struct.new(
  :preview,
  :name,
  :recipe_step,
  :step_index,
  :client_session_id,
  :view_frame)
  SENSITIVE = [:client_session_id]
  include Aws::Structure
end