put_invocation_step ¶

def put_invocation_step(
    self,
    session_identifier: "capo_bedrock_agent_runtime.types.session_identifier.SessionIdentifier",
    invocation_identifier: "capo_bedrock_agent_runtime.types.invocation_identifier.InvocationIdentifier",
    invocation_step_time: "capo_bedrock_agent_runtime.types.date_timestamp.DateTimestamp",
    payload: "capo_bedrock_agent_runtime.types.invocation_step_payload.InvocationStepPayload",
    *,
    config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
    invocation_step_id: Optional[
        "capo_bedrock_agent_runtime.types.uuid.Uuid"
    ] = None,
) -> "capo_bedrock_agent_runtime.types.put_invocation_step_response.PutInvocationStepResponse":
    """<p>Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p> <p>Related APIs:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetInvocationStep.html">GetInvocationStep</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocationSteps.html">ListInvocationSteps</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocations.html">ListInvocations</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocations.html">ListSessions</a> </p> </li> </ul>

    Args:
        session_identifier: <p>The unique identifier for the session to add the invocation step to. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
        invocation_identifier: <p>The unique identifier (in UUID format) of the invocation to add the invocation step to.</p>
        invocation_step_time: <p>The timestamp for when the invocation step occurred.</p>
        payload: <p>The payload for the invocation step, including text and images for the interaction.</p>
        invocation_step_id: <p>The unique identifier of the invocation step in UUID format.</p>

    Raises:
        capo_bedrock_agent_runtime.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions. Check your permissions and retry your request.</p>
        capo_bedrock_agent_runtime.errors.conflict_exception.ConflictException: <p>There was a conflict performing an operation. Resolve the conflict and retry your request.</p>
        capo_bedrock_agent_runtime.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent_runtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
        capo_bedrock_agent_runtime.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
        capo_bedrock_agent_runtime.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent_runtime.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent_runtime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agent_runtime.types.put_invocation_step_request.PutInvocationStepRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent_runtime.types.put_invocation_step_response.PutInvocationStepResponse"
    ]:
        import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.put_invocation_step

        output, http_response = (
            capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.put_invocation_step.put_invocation_step(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_bedrock_agent_runtime.types.put_invocation_step_request.PutInvocationStepRequest",
    ) -> dict[str, Any]:
        import capo_bedrock_agent_runtime.types.put_invocation_step_request

        return capo_bedrock_agent_runtime.types.put_invocation_step_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("PutInvocationStep", redact_input=_redact_input),
    )
    input_: capo_bedrock_agent_runtime.types.put_invocation_step_request.PutInvocationStepRequest = {
        "session_identifier": session_identifier,
        "invocation_identifier": invocation_identifier,
        "invocation_step_time": invocation_step_time,
        "payload": payload,
    }
    if invocation_step_id is not None:
        input_["invocation_step_id"] = invocation_step_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output