Skip to content

SendProjectSessionActionRequest

Source code in docs_src/capo_databrew/types/send_project_session_action_request.py
class SendProjectSessionActionRequest(TypedDict, closed=True):
    preview: "capo_databrew.types.preview.Preview"
    """<p>If true, the result of the recipe step will be returned, but not applied.</p>"""
    name: "capo_databrew.types.project_name.ProjectName"
    """<p>The name of the project to apply the action to.</p>"""
    recipe_step: NotRequired["capo_databrew.types.recipe_step.RecipeStep"]
    step_index: NotRequired["capo_databrew.types.step_index.StepIndex"]
    """<p>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.</p>"""
    client_session_id: NotRequired[
        "capo_databrew.types.client_session_id.ClientSessionId"
    ]
    """<p>A unique identifier for an interactive session that's currently open and ready for work. The action will be performed on this session.</p>"""
    view_frame: NotRequired["capo_databrew.types.view_frame.ViewFrame"]

client_session_id instance-attribute

client_session_id: NotRequired[ClientSessionId]

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

name instance-attribute

The name of the project to apply the action to.

preview instance-attribute

preview: Preview

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

recipe_step instance-attribute

recipe_step: NotRequired[RecipeStep]

step_index instance-attribute

step_index: NotRequired[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.

view_frame instance-attribute

view_frame: NotRequired[ViewFrame]