Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SendProjectSessionAction

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

Request Syntax


PUT /projects/name/sendProjectSessionAction HTTP/1.1
Content-type: application/json

{
   "ClientSessionId": "string",
   "Preview": boolean,
   "RecipeStep": { 
      "Action": { 
         "Operation": "string",
         "Parameters": { 
            "string" : "string" 
         }
      },
      "ConditionExpressions": [ 
         { 
            "Condition": "string",
            "TargetColumn": "string",
            "Value": "string"
         }
      ]
   },
   "StepIndex": number,
   "ViewFrame": { 
      "Analytics": "string",
      "ColumnRange": number,
      "HiddenColumns": [ "string" ],
      "RowRange": number,
      "StartColumnIndex": number,
      "StartRowIndex": number
   }
}

URI Request Parameters

The request uses the following URI parameters.

name

The name of the project to apply the action to.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientSessionId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$

Required: No

Preview

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

Type: Boolean

Required: No

RecipeStep

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

Type: RecipeStep object

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

ViewFrame

Represents the data being transformed during an action.

Type: ViewFrame object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ActionId": number,
   "Name": "string",
   "Result": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Name

The name of the project that was affected by the action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

ActionId

A unique identifier for the action that was performed.

Type: Integer

Result

A message indicating the result of performing the action.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ValidationException

The input parameters for this request failed validation.

HTTP Status Code: 400