Skip to content

get_invocation_step

get_invocation_step(
    invocation_identifier: InvocationIdentifier,
    invocation_step_id: Uuid,
    session_identifier: SessionIdentifier,
    *,
    config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
) -> GetInvocationStepResponse

Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

  • invocation_identifier (InvocationIdentifier) –

    The unique identifier for the invocation in UUID format.

  • invocation_step_id (Uuid) –

    The unique identifier (in UUID format) for the specific invocation step to retrieve.

  • session_identifier (SessionIdentifier) –

    The unique identifier for the invocation step's associated session. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

Raises:

  • AccessDeniedException –

    The request is denied because of missing access permissions. Check your permissions and retry your request.

  • InternalServerException –

    An internal server error occurred. Retry your request.

  • ResourceNotFoundException –

    The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ThrottlingException –

    The number of requests exceeds the limit. Resubmit your request later.

  • ValidationException –

    Input validation failed. Check your request parameters and retry the request.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_bedrock_agent_runtime/_services/bedrock_agent_runtime.py
def get_invocation_step(
    self,
    invocation_identifier: "capo_bedrock_agent_runtime.types.invocation_identifier.InvocationIdentifier",
    invocation_step_id: "capo_bedrock_agent_runtime.types.uuid.Uuid",
    session_identifier: "capo_bedrock_agent_runtime.types.session_identifier.SessionIdentifier",
    *,
    config_overrides: Optional[BedrockAgentRuntimeClientConfig] = None,
) -> "capo_bedrock_agent_runtime.types.get_invocation_step_response.GetInvocationStepResponse":
    """<p>Retrieves the details of a specific invocation step within an invocation in a session. 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>

    Args:
        invocation_identifier: <p>The unique identifier for the invocation in UUID format.</p>
        invocation_step_id: <p>The unique identifier (in UUID format) for the specific invocation step to retrieve.</p>
        session_identifier: <p>The unique identifier for the invocation step's associated session. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</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.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.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.get_invocation_step_request.GetInvocationStepRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agent_runtime.types.get_invocation_step_response.GetInvocationStepResponse"
    ]:
        import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.get_invocation_step

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

    def _redact_output(
        output: "capo_bedrock_agent_runtime.types.get_invocation_step_response.GetInvocationStepResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agent_runtime.types.get_invocation_step_response

        return capo_bedrock_agent_runtime.types.get_invocation_step_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetInvocationStep", redact_output=_redact_output),
    )
    input_: capo_bedrock_agent_runtime.types.get_invocation_step_request.GetInvocationStepRequest = {
        "invocation_identifier": invocation_identifier,
        "invocation_step_id": invocation_step_id,
        "session_identifier": session_identifier,
    }

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