end_session `async` ¶

end_session(
    session_identifier: SessionIdentifier,
    *,
    config_overrides: Optional[AsyncBedrockAgentRuntimeClientConfig] = None,
) -> EndSessionResponse

Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

session_identifier (SessionIdentifier) –

The unique identifier for the session to end. 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.
ConflictException –

There was a conflict performing an operation. Resolve the conflict 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/async_bedrock_agent_runtime.py

async def end_session(
    self,
    session_identifier: "capo_bedrock_agent_runtime.types.session_identifier.SessionIdentifier",
    *,
    config_overrides: Optional[AsyncBedrockAgentRuntimeClientConfig] = None,
) -> "capo_bedrock_agent_runtime.types.end_session_response.EndSessionResponse":
    """<p>Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. 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:
        session_identifier: <p>The unique identifier for the session to end. 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.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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agent_runtime.types.end_session_request.EndSessionRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent_runtime.types.end_session_response.EndSessionResponse"
    ]:
        import capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.end_session

        (
            output,
            http_response,
        ) = await capo_bedrock_agent_runtime._operations.amazon_bedrock_agent_run_time_service.end_session.async_end_session(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("EndSession")
    )
    input_: capo_bedrock_agent_runtime.types.end_session_request.EndSessionRequest = {
        "session_identifier": session_identifier
    }

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

end_session async ¶

end_session `async` ¶