Skip to content

send_project_session_action async

send_project_session_action(
    name: ProjectName,
    *,
    config_overrides: Optional[AsyncDataBrewClientConfig] = None,
    preview: Optional[Preview] = None,
    recipe_step: Optional[RecipeStep] = None,
    step_index: Optional[StepIndex] = None,
    client_session_id: Optional[ClientSessionId] = None,
    view_frame: Optional[ViewFrame] = None,
) -> SendProjectSessionActionResponse

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

Parameters:

  • preview (Optional[Preview], default: None ) –

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

  • name (ProjectName) –

    The name of the project to apply the action to.

  • step_index (Optional[StepIndex], default: None ) –

    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.

  • client_session_id (Optional[ClientSessionId], default: None ) –

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

Raises:

Source code in docs_src/capo_databrew/_services/async_data_brew.py
async def send_project_session_action(
    self,
    name: "capo_databrew.types.project_name.ProjectName",
    *,
    config_overrides: Optional[AsyncDataBrewClientConfig] = None,
    preview: Optional["capo_databrew.types.preview.Preview"] = None,
    recipe_step: Optional["capo_databrew.types.recipe_step.RecipeStep"] = None,
    step_index: Optional["capo_databrew.types.step_index.StepIndex"] = None,
    client_session_id: Optional[
        "capo_databrew.types.client_session_id.ClientSessionId"
    ] = None,
    view_frame: Optional["capo_databrew.types.view_frame.ViewFrame"] = None,
) -> "capo_databrew.types.send_project_session_action_response.SendProjectSessionActionResponse":
    """<p>Performs a recipe step within an interactive DataBrew session that's currently open.</p>

    Args:
        preview: <p>If true, the result of the recipe step will be returned, but not applied.</p>
        name: <p>The name of the project to apply the action to.</p>
        step_index: <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: <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>

    Raises:
        capo_databrew.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_databrew.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_databrew.errors.validation_exception.ValidationException: <p>The input parameters for this request failed validation.</p>
        capo_databrew.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_databrew.types.send_project_session_action_request.SendProjectSessionActionRequest]",
    ) -> AsyncOperationResponse[
        "capo_databrew.types.send_project_session_action_response.SendProjectSessionActionResponse"
    ]:
        import capo_databrew._operations.aws_glue_data_brew.send_project_session_action

        (
            output,
            http_response,
        ) = await capo_databrew._operations.aws_glue_data_brew.send_project_session_action.async_send_project_session_action(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_databrew.types.send_project_session_action_request.SendProjectSessionActionRequest",
    ) -> dict[str, Any]:
        import capo_databrew.types.send_project_session_action_request

        return capo_databrew.types.send_project_session_action_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("SendProjectSessionAction", redact_input=_redact_input),
    )
    input_: capo_databrew.types.send_project_session_action_request.SendProjectSessionActionRequest = {
        "name": name
    }
    if preview is not None:
        input_["preview"] = preview
    if recipe_step is not None:
        input_["recipe_step"] = recipe_step
    if step_index is not None:
        input_["step_index"] = step_index
    if client_session_id is not None:
        input_["client_session_id"] = client_session_id
    if view_frame is not None:
        input_["view_frame"] = view_frame

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output